Skip to main content
POST
/
hostedextractors
/
preview
/
result
Get preview result
curl --request POST \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/hostedextractors/preview/result \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalId": "my.known.id"
}
'
{
  "type": "error",
  "externalId": "my.known.id",
  "kind": "startup_error",
  "createdTime": 1730204346000,
  "message": "<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

External ID of preview job to get result for.

​
externalId
string
required

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

Maximum string length: 255
Example:

"my.known.id"

Response

Current status of the preview.

Result of a failed preview.

​
type
enum<string>
required

Result type

Available options:
error
​
externalId
string
required

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

Maximum string length: 255
Example:

"my.known.id"

​
kind
enum<string>
required

The type of error that occured. If the type is transform_error, raw data is usually available in the /download endpoint.

Available options:
startup_error,
connection_error,
transform_error
​
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

​
message
string

Error message.

Last modified on April 23, 2026