Skip to main content
GET
Get dataset sampling status

Authorizations

Authorization
string
header
required

Enter ApiKey <your-api-key> in Authorization, including the ApiKey prefix. In cURL and Python samples, <api-key> means this full value. The TypeScript SDK adds the prefix for you.

Path Parameters

sampleId
string
required

ID of the sampling operation, with prefix dsm..

Pattern: ^dsm\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Response

Sampling job status

createdAt
string<date-time>
required

Time the sampling operation was requested, as an ISO 8601 timestamp.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
datasetId
string
required

Dataset ID with prefix ds..

Pattern: ^ds\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
fieldId
string
required

Field the marker is written into.

Pattern: ^df\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
id
string
required

Sampling operation ID with prefix dsm..

Pattern: ^dsm\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
marked
integer
required

How many rows carry the marker so far.

Required range: 0 <= x <= 9007199254740991
markerValue
string
required

Marker value being written.

status
enum<string>
required

Whether the marking has finished.

Available options:
running,
succeeded
target
integer
required

The target number of marked rows.

Required range: 0 <= x <= 9007199254740991