GetData - Sift

GetData

curl --request POST \
  --url https://api.siftstack.com/api/v1/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>"
}
'

import requests

url = "https://api.siftstack.com/api/v1/data"

payload = {
    "queries": [{ "channel": {
                "channelId": "<string>",
                "runId": "<string>"
            } }],
    "startTime": "2023-11-07T05:31:56Z",
    "endTime": "2023-11-07T05:31:56Z",
    "sampleMs": 123,
    "pageSize": 123,
    "pageToken": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.siftstack.com/api/v1/data"

	payload := strings.NewReader("{\n  \"queries\": [\n    {\n      \"channel\": {\n        \"channelId\": \"<string>\",\n        \"runId\": \"<string>\"\n      }\n    }\n  ],\n  \"startTime\": \"2023-11-07T05:31:56Z\",\n  \"endTime\": \"2023-11-07T05:31:56Z\",\n  \"sampleMs\": 123,\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": [
    {
      "@type": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

POST

/

api

/

v1

/

data

GetData

curl --request POST \
  --url https://api.siftstack.com/api/v1/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>"
}
'

import requests

url = "https://api.siftstack.com/api/v1/data"

payload = {
    "queries": [{ "channel": {
                "channelId": "<string>",
                "runId": "<string>"
            } }],
    "startTime": "2023-11-07T05:31:56Z",
    "endTime": "2023-11-07T05:31:56Z",
    "sampleMs": 123,
    "pageSize": 123,
    "pageToken": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.siftstack.com/api/v1/data"

	payload := strings.NewReader("{\n  \"queries\": [\n    {\n      \"channel\": {\n        \"channelId\": \"<string>\",\n        \"runId\": \"<string>\"\n      }\n    }\n  ],\n  \"startTime\": \"2023-11-07T05:31:56Z\",\n  \"endTime\": \"2023-11-07T05:31:56Z\",\n  \"sampleMs\": 123,\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": [
    {
      "@type": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

queries

object[]

Show child attributes

startTime

string<date-time>

Required. The starting timestamp of the data to retrieve. This is an inclusive bound.

endTime

string<date-time>

Required. The end timestamp of the data to retrieve. This is an exclusive bound.

sampleMs

integer<int64>

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. A value of 0 disables sampling and returns the full unsampled dataset. This is recommended for external data analysis where full fidelity is required, as opposed to plotting where downsampling is typically sufficient.

pageSize

integer<int64>

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 1,000,000; values above 1,000,000 will be coerced to 1,000,000. For variable data types (i.e. string channels), at most page_size elements will be read, or 1MB, whichever occurs first.

pageToken

string

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.

data

data contains the result of the supplied queries. Be aware that each query can generate multiple data responses. For example, if run_id is omitted from a ChannelQuery, the query returns data for all runs containing that channel. Channel data for each run is returned in a separate data object. Possible message types: sift.data.v1.DoubleValues sift.data.v1.FloatValues sift.data.v1.StringValues sift.data.v1.EnumValues sift.data.v1.BitFieldValues sift.data.v1.BoolValues sift.data.v1.Int32Values sift.data.v1.Int64Values sift.data.v1.Uint32Values sift.data.v1.Uint64Values sift.data.v1.BytesValues · object[]

required

Show child attributes

nextPageToken

string

⌘I