Skip to main content
POST
/
advancedjoins
/
suggestimprovements
Suggest improvements
curl --request POST \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/advancedjoins/suggestimprovements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "advancedJoinExternalId": "my.known.id",
  "limit": 20
}
'
{
  "jobId": "<string>",
  "status": "Queued",
  "createdTime": 1730204346000,
  "startTime": 1730204346000,
  "statusTime": 1730204346000,
  "advancedJoinExternalId": "my.known.id",
  "errorMessage": null,
  "improvementSuggestions": [
    {
      "type": "direct",
      "space": "<string>",
      "originExternalId": "<string>",
      "propertyName": "<string>"
    }
  ]
}

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"

​
limit
integer
default:20
Required range: 1 <= x <= 1000

Response

The resulting suggestions.

​
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"

​
errorMessage
string

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

Example:

null

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