Run Query (Legacy)

Query (Legacy)

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id

string

required

Query Parameters

saveAsKind

string

streaming-duration

string

nocache

boolean

Body

application/json

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

object[]

Show child attributes

aggregations.field

string

required

aggregations.op

enum<string>

required

Available options:

count,

distinct,

sum,

avg,

min,

max,

topk,

percentiles,

histogram,

stdev,

variance,

argmin,

argmax,

makeset,

rate,

makelist

aggregations.alias

string

aggregations.argument

object

continuationToken

string

cursor

string

filter

object

Show child attributes

filter.field

string

required

filter.op

enum<string>

required

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

Available options:

and,

or,

not,

eq,

!=,

ne,

exists,

not-exists,

gt,

gte,

lt,

lte,

starts-with,

not-starts-with,

ends-with,

not-ends-with,

contains,

not-contains,

regexp,

not-regexp

filter.caseSensitive

boolean

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

filter.children

string[]

Supported for these filters: and, or, not.

filter.value

object

groupBy

string[]

includeCursor

boolean

limit

integer

order

object[]

Show child attributes

order.desc

boolean

required

order.field

string

required

project

object[]

Show child attributes

project.field

string

required

project.alias

string

queryOptions

object

Show child attributes

queryOptions.against

string

queryOptions.againstStart

string

queryOptions.againstTimestamp

string

queryOptions.aggChartOpts

string

queryOptions.caseSensitive

string

queryOptions.containsTimeFilter

string

queryOptions.datasets

string

queryOptions.displayNull

string

queryOptions.editorContent

string

queryOptions.endColumn

string

queryOptions.endLineNumber

string

queryOptions.endTime

string

queryOptions.integrationsFilter

string

queryOptions.openIntervals

string

queryOptions.quickRange

string

queryOptions.resolution

string

queryOptions.shownColumns

string

queryOptions.startColumn

string

queryOptions.startLineNumber

string

queryOptions.startTime

string

queryOptions.timeSeriesVariant

string

queryOptions.timeSeriesView

string

virtualFields

object[]

Show child attributes

virtualFields.alias

string

required

virtualFields.expr

string

required

Response

200 - application/json

buckets

object

required

Show child attributes

buckets.series

object[]

Show child attributes

buckets.series.endTime

string

required

buckets.series.startTime

string

required

buckets.series.groups

object[]

Show child attributes

buckets.series.groups.group

object

required

Show child attributes

buckets.series.groups.group.{key}

object

buckets.series.groups.id

integer

required

buckets.series.groups.aggregations

object[]

Show child attributes

buckets.series.groups.aggregations.op

string

required

buckets.series.groups.aggregations.value

object

required

buckets.series.groups.aggregations.data

object

buckets.totals

object[]

Show child attributes

buckets.totals.group

object

required

Show child attributes

buckets.totals.group.{key}

object

buckets.totals.id

integer

required

buckets.totals.aggregations

object[]

Show child attributes

buckets.totals.aggregations.op

string

required

buckets.totals.aggregations.value

object

required

buckets.totals.aggregations.data

object

format

string

required

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

status

object

required

Show child attributes

status.blocksExamined

integer

required

status.cacheStatus

integer

required

status.elapsedTime

integer

required

status.isPartial

boolean

required

status.maxBlockTime

string

required

status.minBlockTime

string

required

status.numGroups

integer

required

status.rowsExamined

integer

required

status.rowsMatched

integer

required

status.continuationToken

string

status.isEstimate

boolean

status.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).

status.messages

object[]

Show child attributes

status.messages.count

integer

required

status.messages.msg

string

required

status.messages.priority

string

required

status.messages.code

string

status.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).

fieldsMeta

object[]

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

Show child attributes

fieldsMeta.hidden

boolean

required

fieldsMeta.name

string

required

fieldsMeta.type

string

required

fieldsMeta.unit

string

required

fieldsMeta.description

string

matches

object[]

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

Show child attributes

matches._rowId

string

required

matches._sysTime

string

required

matches._time

string

required

matches.data

object

required

Show child attributes

matches.data.{key}

object

tables

object[]

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

Show child attributes

tables.buckets

object

The standard mode of operation for Kirby is to create buckets on the _time column,

Show child attributes

tables.buckets.field

string

Field specifies the field used to create buckets on. Normally this would be _time.

tables.buckets.size

object

An integer or float representing the fixed bucket size. When the bucket field is _time this value is in nanoseconds.

tables.columns

array

Columns contain a series of arrays with the raw result data. The columns here line up with the fields in the Fields array.

tables.fields

object[]

Fields contain information about the fields included in these results. The order of the fields match up with the order of the data in Columns.

Show child attributes

tables.fields.agg

object

AggInfo captures information about an aggregation

Show child attributes

tables.fields.agg.args

object[]

Args specifies any non-field arguments for the aggregation. Fx. [10] for topk(players, 10).

tables.fields.agg.fields

string[]

Fields specifies the names of the fields this aggregation is computed on. Fx ["players"] for topk(players, 10)

tables.fields.agg.name

string

Name is the system name of the aggregation, which is the string form of aggregation.Type. If the aggregation is aliased, the alias is stored in the parent FieldInfo

tables.fields.name

string

tables.fields.type

string

tables.groups

object[]

Groups specifies which grouping operations has been performed on the results.

Show child attributes

tables.groups.name

string

tables.name

string

Name is the name assigned to this table. Defaults to "0". The name "_totals" is reserved for system use.

tables.order

object[]

Order echoes the ordering clauses that was used to sort the results.

Show child attributes

tables.order.desc

boolean

required

tables.order.field

string

required

tables.range

object

Show child attributes

tables.range.end

string

End is the ending time the query is limited by. Queries are restricted to the interval [start,end).

tables.range.field

string

Field specifies the field name on which the query range was restricted. Normally _time

tables.range.start

string

Start is the starting time the query is limited by. Queries are restricted to the interval [start,end).

tables.sources

object[]

Sources contain the names of the datasets that contributed data to these results.

Show child attributes

tables.sources.name

string