Create a dataset slice
Freeze the selected rows and fields at one cutoff. Use fromSlice to reuse an existing slice’s filter at a new cutoff. Split fields are always frozen. Returns a slice with status creating; poll until ready or failed. Uploads and blocking field operations prevent creation.
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 dataset rows and fields to freeze at one cutoff. The resulting slice keeps those rows and frozen values; create another slice to include later changes.
Fields to freeze, by name or ID. Defaults to all fields. Split fields are always frozen; other fields omitted here keep their latest values.
500Select rows at the slice cutoff. Omit to include all rows. This filter cannot use createdBefore, another slice, or split parts.
A name to tell slices apart, for example "October eval". Defaults to Slice 1, Slice 2 and so on.
1 - 120Response
Slice started
When the slice was requested.
^(?:(?:\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))$The moment the slice was taken: its rows and its frozen fields are read as they were just before it.
^(?:(?:\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))$ID of the dataset containing this slice, 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}$Why the slice failed.
The slice this one was taken from, if any.
^dsl\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$Fields the slice reads as they were at its cutoff. Other fields read live.
^df\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$Slice id. The same id always selects the same rows with the same frozen values.
^dsl\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$The filter the rows matched when the slice was taken; null for every row.
The name that tells this slice apart.
1 - 120Rows in the slice once it is ready; 0 until then.
0 <= x <= 9007199254740991Only a ready slice can select rows.
creating, ready, failed