Query (Legacy)

post
/v1/datasets/{id}/query

Query Parameters

ParamTypeDescription

saveAsKind

string

streaming-duration

string

nocache

boolean

Path Parameters

ParamTypeDescription

id

string

required

Body Parameters

ParamTypeDescription

endTime

string

required

resolution

string

required

The time resolution of the query’s graph, in seconds. Valid values are the query’s time range /100 at maximum and /1000 at minimum or "auto".

startTime

string

required

start and end time for the query, these must be specified as RFC3339 strings or using relative time expressions (e.g. now-1h, now-1d, now-1w, etc)

aggregations

array

continuationToken

string

cursor

string

filter

object

Properties

caseSensitive <boolean>

Supported for these filters: starts-with, not-starts-with, ends-with, not-ends-with, contains, not-contains, eq, ne.

children <array>

Supported for these filters: and, or, not.

field <string>

op <string>

we also support '==', but we're not exporting that to swagger, cause it can't deal with it add >, >=, <, <= to that list, it breaks codegen

value <object>

groupBy

array

includeCursor

boolean

limit

integer

order

array

project

array

queryOptions

object

Properties

against <string>

againstStart <string>

againstTimestamp <string>

aggChartOpts <string>

caseSensitive <string>

containsTimeFilter <string>

datasets <string>

displayNull <string>

editorContent <string>

endColumn <string>

endLineNumber <string>

endTime <string>

integrationsFilter <string>

openIntervals <string>

quickRange <string>

resolution <string>

shownColumns <string>

startColumn <string>

startLineNumber <string>

startTime <string>

timeSeriesVariant <string>

timeSeriesView <string>

virtualFields

array

Responses

200
Result, an object with the following properties:
PropertyTypeDescription

buckets

object

Properties

series <array>

totals <array>

fieldsMeta

array

FieldsMeta contains the unit information (if we have it) for each field

format

string

Format specifies the result set format. Either "legacy" (default) or "tabular".

matches

array

Matches hold the matching events of a filter query in the "legacy" result format

status

object

required
Properties

blocksExamined <integer>

cacheStatus <integer>

continuationToken <string>

elapsedTime <integer>

isEstimate <boolean>

isPartial <boolean>

maxBlockTime <string>

maxCursor <string>

Row id of the newest row, as seen server side. May be higher than what the results include if the server scanned more data than included in the results. Can be used to efficiently resume time-sorted non-aggregating queries (ie filtering only).

messages <array>

minBlockTime <string>

minCursor <string>

Row id of the oldest row, as seen server side. May be lower than what the results include if the server scanned more data than included in the results. Can be used to efficiently resume time-sorted non-aggregating queries (ie filtering only).

numGroups <integer>

rowsExamined <integer>

rowsMatched <integer>

tables

array

Tables hold the result tables in the "tabular" result format

401
Forbidden, an object with the following properties:
PropertyTypeDescription

code

string

message

string

Was this page helpful?