Skip to main content
POST
/
advancedjoins
/
estimatequality
Estimate contextualization quality
curl --request POST \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/advancedjoins/estimatequality \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "advancedJoinExternalId": "my.known.id",
  "matcher": {
    "type": "raw",
    "dbName": "<string>",
    "tableName": "<string>",
    "fromColumnKey": "<string>",
    "toColumnKey": "<string>"
  },
  "dummyResponse": false
}
'
{
  "jobId": "<string>",
  "status": "Queued",
  "createdTime": 1730204346000,
  "startTime": 1730204346000,
  "statusTime": 1730204346000,
  "advancedJoinExternalId": "my.known.id",
  "matcher": {
    "type": "raw",
    "dbName": "<string>",
    "tableName": "<string>",
    "fromColumnKey": "<string>",
    "toColumnKey": "<string>"
  },
  "errorMessage": null,
  "qualityScorePercent": 50,
  "confidencePercent": 50,
  "contextualizationScorePercent": 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
​
advancedJoinExternalId
string
required

The external ID provided by the client. Must be unique for the resource type.

Maximum string length: 255
Example:

"my.known.id"

​
matcher
object
required

The Raw matcher can be used when you already have a collection of known matches, stored in a Raw table.

​
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

​
advancedJoinExternalId
string
required

The external ID provided by the client. Must be unique for the resource type.

Maximum string length: 255
Example:

"my.known.id"

​
matcher
object
required

The Raw matcher can be used when you already have a collection of known matches, stored in a Raw table.

​
errorMessage
string

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

Example:

null

​
qualityScorePercent
number

The quality of the Join, calculated as the ratio of correctly mapped instances to all mapped instances.

Required range: 0 <= x <= 100
​
confidencePercent
number
Required range: 0 <= x <= 100
​
contextualizationScorePercent
number
Required range: 0 <= x <= 100
Last modified on April 23, 2026