Mark a deterministic sample of rows
Send markField, markValue, and exactly one of count or fraction, with an optional filter. Marks a repeatable subset of rows in the background and returns a sampling ID. Increasing the size extends the existing sample.
Authorizations
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
Dataset ID with prefix ds..
^ds\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$Body
- Option 1
- Option 2
Select exactly one of count or fraction, plus a marker field and value. Repeating the request preserves the sample; increasing its size extends it.
How many rows to end up marked with this value, capped at how many the filter matches.
x <= 9007199254740991Field the marker is written to, by field name or id.
Value written into the marker field, for example "golden".
1 - 64Narrow which rows are eligible. Omit to consider every row.
Response
Sampling started
The sampling ID. Use it to poll the sampling status.
^dsm\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$The target number of marked rows, calculated when the request is made. Poll the sampling status for progress.
0 <= x <= 9007199254740991