Skip to main content
POST
/
advancedjoins
/
measuremappedpercentage
Measure mapped percentages
curl --request POST \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/advancedjoins/measuremappedpercentage \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "space": "<string>",
  "viewExternalId": "<string>",
  "viewVersion": "<string>",
  "dummyResponse": false
}
'
{
  "jobId": "<string>",
  "status": "Queued",
  "createdTime": 1730204346000,
  "startTime": 1730204346000,
  "statusTime": 1730204346000,
  "errorMessage": null,
  "items": [
    {
      "propertyName": "<string>",
      "mappedPercentage": 50
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.

Body

application/json
​
space
string
required
Required string length: 1 - 43
Pattern: ^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$
​
viewExternalId
string
required
Required string length: 1 - 255
Pattern: ^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$
​
viewVersion
string
required
Required string length: 1 - 43
Pattern: ^[a-zA-Z0-9]([.a-zA-Z0-9_-]{0,41}[a-zA-Z0-9])?$
​
dummyResponse
boolean
default:false

Whether to return a bogus response that complies with the expected schema. This will be removed in a future iteration.

Response

The resulting advanced join job.

​
jobId
string
required

ID of an advanced join job. These are always UUIDs.

​
status
enum<string>
required

The status of the job.

Available options:
Queued,
Running,
Completed,
Failed
​
createdTime
integer<int64>
required

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0
Example:

1730204346000

​
startTime
integer<int64>
required

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0
Example:

1730204346000

​
statusTime
integer<int64>
required

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0
Example:

1730204346000

​
errorMessage
string

If the job failed, some more information about the error cause.

Example:

null

​
items
object[]
Last modified on April 23, 2026