Skip to main content
POST
Query a canvas dataset

Authorizations

Authorization
string
header
required

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

Headers

authorization
string | null
x-ankra-organisation-id
string | null

Path Parameters

dataset_id
string
required

Body

application/json
time_range
object
required
params
object
step_seconds
integer
Required range: x >= 1
compare_previous
boolean
default:false

Response

The query ran. Its state says whether data came back: ok, empty, stale, unavailable (the source could not be read or did not answer within 10 seconds; reason says why) or denied (the cluster named in params is not visible to the caller).

state
enum<string>
required
Available options:
ok,
empty,
stale,
unavailable,
denied
observed_at
string | null
required

RFC 3339 time of the newest observation the source holds for the answer; null when nothing was observed.

source
string
required
query_description
string
required
reason
string

Why the state is not ok, when the source said.

series
CanvasDatasetSeries · object[]
rows
CanvasDatasetRows · object
value
object
statuses
object[]
truncated
boolean

A series, point or row cap cut the answer short.

previous
CanvasDatasetPeriod · object

The same query over the previous period.