REST API
- GET /api/v1/data
Get records
Get records for the provided range of keys: [key_min, key_max). Each key consists of cid, mid, moid identifiers and cap, acq timestamps representing capture and acquisition times. All keys of fetched records satisfy min_key <= key < max_key for each key dimension. Payload data is processed based on payload_columns parameter.
- Query Parameters:
cid_min (integer) – Start of cid range (Required)
cid_max (integer) – End of cid range (Required)
mid_min (integer) – Start of mid range (Required)
mid_max (integer) – End of mid range (Required)
moid_min (integer) – Start of moid range (Required)
moid_max (integer) – End of moid range (Required)
time_unit (string) – Time unit for all timestamps in both request and response (Required)
cap_min (string) – Start of capture time range (Required)
cap_max (string) – End of capture time range (Required)
acq_min ({'null', 'string'}) – Start of acquisition time range
acq_max ({'null', 'string'}) – End of acquisition time range
payload_types (array) – List of expected types in payload, possible values: int8, int16, int32, int64, uint8, uint16, uint32, uint64, float32, float64, bytes (Required)
- Status Codes:
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- POST /api/v1/data
Save records
Data field of the request is a list of records to be saved. Each record requires elements of the key and payload values. Key consists of cid, mid, moid identifiers and cap timestamp representing capture time. Other fields of the record are payload values.Metadata field of the request has a time_unit field used to interpret capture timestamps and a list of column metadata with column names and types used to interpret payload values.
- Status Codes:
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- GET /api/v1/data/stream
Get stream of records
Get stream of records for the provided range of keys: [key_min, key_max). Each key consists of cid, mid, moid identifiers and cap, acq timestamps representing capture and acquisition times. All keys of fetched records satisfy min_key <= key < max_key for each key dimension. Payload data is processed based on payload_columns parameter.
- Query Parameters:
cid_min (integer) – Start of cid range (Required)
cid_max (integer) – End of cid range (Required)
mid_min (integer) – Start of mid range (Required)
mid_max (integer) – End of mid range (Required)
moid_min (integer) – Start of moid range (Required)
moid_max (integer) – End of moid range (Required)
time_unit (string) – Time unit for all timestamps in both request and response (Required)
cap_min (string) – Start of capture time range (Required)
cap_max (string) – End of capture time range (Required)
acq_min ({'null', 'string'}) – Start of acquisition time range
acq_max ({'null', 'string'}) – End of acquisition time range
payload_types (array) – List of expected types in payload, possible values: int8, int16, int32, int64, uint8, uint16, uint32, uint64, float32, float64, bytes (Required)
- Status Codes:
200 OK – Successful Response
422 Unprocessable Entity – Validation Error