Clients
Review
Endpoints & protobuf definitions
curl --request POST \
--url https://api.siftstack.com/api/v2/data \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"queries": [
{
"channel": {
"channelId": "<string>",
"runId": "<string>"
}
}
],
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"sampleMs": 123,
"pageSize": 123,
"pageToken": "<string>"
}
'{
"data": [
{
"@type": "<string>"
}
],
"nextPageToken": "<string>"
}GetData
Query data
curl --request POST \
--url https://api.siftstack.com/api/v2/data \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"queries": [
{
"channel": {
"channelId": "<string>",
"runId": "<string>"
}
}
],
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"sampleMs": 123,
"pageSize": 123,
"pageToken": "<string>"
}
'{
"data": [
{
"@type": "<string>"
}
],
"nextPageToken": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.siftstack.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Show child attributes
Show child attributes
Required. The starting timestamp of the data to retrieve. This is an inclusive bound.
Required. The end timestamp of the data to retrieve. This is an exclusive bound.
The rate to sample the returned data at. The data is sampled using LTTB which will return one point approximately every sample_ms milliseconds that retains the shape of the raw data. Sampling is only supported for numeric data types, if sample_ms is provided for non-numeric data, it will be ignored and the full-fidelity data will be returned.
The maximum number of channel values to return. The service may return fewer than this value. If unspecified, at most 10,000 values will be returned. The maximum value is 100,000; values above 100,000 will be coerced to 100,000. For variable data types (i.e. string channels), at most page_size elements will be read, or 1MB, whichever occurs first.
A page token, received from a previous GetData call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to GetData must match
the call that provided the page token.
Response
A successful response.
Show child attributes
Show child attributes
Was this page helpful?