Skip to main content
POST
Mark a deterministic sample of rows

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

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}$

Body

application/json

Select exactly one of count or fraction, plus a marker field and value. Repeating the request preserves the sample; increasing its size extends it.

count
integer
required

How many rows to end up marked with this value, capped at how many the filter matches.

Required range: x <= 9007199254740991
markField
string
required

Field the marker is written to, by field name or id.

markValue
string
required

Value written into the marker field, for example "golden".

Required string length: 1 - 64
itemFilter
object

Narrow which rows are eligible. Omit to consider every row.

Response

Sampling started

id
string
required

The sampling ID. Use it to poll the sampling status.

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

The target number of marked rows, calculated when the request is made. Poll the sampling status for progress.

Required range: 0 <= x <= 9007199254740991