Skip to main content
POST
TypeScript SDK

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 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.

frozenColumns
string[]

Fields to freeze, by name or ID. Defaults to all fields. Split fields are always frozen; other fields omitted here keep their latest values.

Maximum array length: 500
itemFilter
object

Select rows at the slice cutoff. Omit to include all rows. This filter cannot use createdBefore, another slice, or split parts.

name
string

A name to tell slices apart, for example "October eval". Defaults to Slice 1, Slice 2 and so on.

Required string length: 1 - 120

Response

Slice started

createdAt
string<date-time>
required

When the slice was requested.

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))$
cutoff
string<date-time>
required

The moment the slice was taken: its rows and its frozen fields are read as they were just before it.

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

ID of the dataset containing this slice, 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}$
error
object | null
required

Why the slice failed.

fromSliceId
string | null
required

The slice this one was taken from, if any.

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

Fields the slice reads as they were at its cutoff. Other fields read live.

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

Slice id. The same id always selects the same rows with the same frozen values.

Pattern: ^dsl\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
itemFilter
object | null
required

The filter the rows matched when the slice was taken; null for every row.

name
string
required

The name that tells this slice apart.

Required string length: 1 - 120
rows
integer
required

Rows in the slice once it is ready; 0 until then.

Required range: 0 <= x <= 9007199254740991
status
enum<string>
required

Only a ready slice can select rows.

Available options:
creating,
ready,
failed