Services
RPC methods exposed by this API.DataService
| Method | Request | Response | Description |
|---|---|---|---|
| GetData | GetDataRequest | GetDataResponse | Query data |
Messages
Data models used across requests/responses.BitFieldElementValues
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| values | BitFieldValue | repeated |
BitFieldValue
| Field | Type | Label | Description |
|---|---|---|---|
| timestamp | google.protobuf.Timestamp | ||
| value | uint32 |
BitFieldValues
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | Metadata | ||
| values | BitFieldElementValues | repeated |
BoolValue
| Field | Type | Label | Description |
|---|---|---|---|
| timestamp | google.protobuf.Timestamp | ||
| value | bool |
BoolValues
BytesValue
| Field | Type | Label | Description |
|---|---|---|---|
| timestamp | google.protobuf.Timestamp | ||
| value | bytes |
BytesValues
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | Metadata | ||
| values | BytesValue | repeated |
CalculatedChannelQuery
| Field | Type | Label | Description |
|---|---|---|---|
| channel_key | string | ||
| expression | sift.calculated_channels.v1.ExpressionRequest | ||
| run_id | string | optional | Optional. If set, only data for the specified run is returned If set to the empty string, only non-run data is returned. If unset, all run / non-run data is returned. |
| mode | sift.calculated_channels.v1.ExpressionMode | optional | Optional. If unset, will default to EXPRESSION_MODE_CALCULATED_CHANNELS. |
| combine_run_data | bool | optional | Optional. If unset, will default to false. If true, then requests that return data across multiple runs will be combined into a single result. This will apply to queries without a run, or when the requested run is an ad hoc run. This is useful when you prefer to see all the data as a single time series, instead of separated results by run. |
ChannelQuery
| Field | Type | Label | Description |
|---|---|---|---|
| channel_id | string | channel_id is the uuid of the channel. | |
| run_id | string | optional | Optional. If set, only data associated with the specified run is returned. If set to the empty string, only non-run data is returned. If unset, all run / non-run data is returned. |
DoubleValue
| Field | Type | Label | Description |
|---|---|---|---|
| timestamp | google.protobuf.Timestamp | ||
| value | double |
DoubleValues
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | Metadata | ||
| values | DoubleValue | repeated |
EnumValue
| Field | Type | Label | Description |
|---|---|---|---|
| timestamp | google.protobuf.Timestamp | ||
| value | uint32 |
EnumValues
FloatValue
| Field | Type | Label | Description |
|---|---|---|---|
| timestamp | google.protobuf.Timestamp | ||
| value | float |
FloatValues
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | Metadata | ||
| values | FloatValue | repeated |
GetDataRequest
| Field | Type | Label | Description |
|---|---|---|---|
| queries | Query | repeated | |
| start_time | google.protobuf.Timestamp | Required. The starting timestamp of the data to retrieve. This is an inclusive bound. | |
| end_time | google.protobuf.Timestamp | Required. The end timestamp of the data to retrieve. This is an exclusive bound. | |
| sample_ms | uint32 | 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. | |
| page_size | uint32 | 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. | |
| page_token | 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. |
GetDataResponse
| Field | Type | Label | Description |
|---|---|---|---|
| next_page_token | string | ||
| data | google.protobuf.Any | repeated | 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.v2.DoubleValues sift.data.v2.FloatValues sift.data.v2.StringValues sift.data.v2.EnumValues sift.data.v2.BitFieldValues sift.data.v2.BoolValues sift.data.v2.Int32Values sift.data.v2.Int64Values sift.data.v2.Uint32Values sift.data.v2.Uint64Values sift.data.v2.BytesValues |
Int32Value
| Field | Type | Label | Description |
|---|---|---|---|
| timestamp | google.protobuf.Timestamp | ||
| value | int32 |
Int32Values
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | Metadata | ||
| values | Int32Value | repeated |
Int64Value
| Field | Type | Label | Description |
|---|---|---|---|
| timestamp | google.protobuf.Timestamp | ||
| value | int64 |
Int64Values
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | Metadata | ||
| values | Int64Value | repeated |
Metadata
| Field | Type | Label | Description |
|---|---|---|---|
| data_type | sift.common.type.v1.ChannelDataType | ||
| sampled_ms | uint32 | ||
| asset | Metadata.Asset | ||
| run | Metadata.Run | optional | |
| channel | Metadata.Channel | optional |
Metadata.Asset
| Field | Type | Label | Description |
|---|---|---|---|
| asset_id | string | ||
| name | string |
Metadata.Channel
| Field | Type | Label | Description |
|---|---|---|---|
| channel_id | string | For channel queries, this will contain the requested backing channel id. For calculated channel queries, this will contain the requested channel key. | |
| name | string | ||
| unit | Metadata.Channel.Unit | ||
| enum_types | sift.common.type.v1.ChannelEnumType | repeated | |
| bit_field_elements | sift.common.type.v1.ChannelBitFieldElement | repeated |
Metadata.Channel.Unit
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| abbreviated_name | string |
Metadata.Run
| Field | Type | Label | Description |
|---|---|---|---|
| run_id | string | The run_id that was sent with the data during ingestion (if any). Note that this may be different from the run_id that was requested in the query. | |
| name | string |
Query
| Field | Type | Label | Description |
|---|---|---|---|
| oneof query. channel | ChannelQuery | ||
| oneof query. calculated_channel | CalculatedChannelQuery |
StringValue
| Field | Type | Label | Description |
|---|---|---|---|
| timestamp | google.protobuf.Timestamp | ||
| value | string |
StringValues
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | Metadata | ||
| values | StringValue | repeated |
Uint32Value
| Field | Type | Label | Description |
|---|---|---|---|
| timestamp | google.protobuf.Timestamp | ||
| value | uint32 |
Uint32Values
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | Metadata | ||
| values | Uint32Value | repeated |
Uint64Value
| Field | Type | Label | Description |
|---|---|---|---|
| timestamp | google.protobuf.Timestamp | ||
| value | uint64 |
Uint64Values
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | Metadata | ||
| values | Uint64Value | repeated |