Run Query
Query
The access token received from the authorization server in the OAuth 2.0 flow.
when saveAsKind is true, this parameter indicates the id of the associated dataset
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)
Variables is an optional set of additional variables that are inserted into the APL
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
legacy, tabular when saveAsKind is true, this parameter indicates the id of the associated dataset
Body
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)
Variables is an optional set of additional variables that are inserted into the APL
Response
FieldsMetaMap contains the unit information (if we have it) for each field in the given dataset entry
Format specifies the result set format. Either "legacy" (default) or "tabular".
Matches hold the matching events of a filter query in the "legacy" result format
count, distinct, sum, avg, min, max, topk, percentiles, histogram, stdev, variance, argmin, argmax, makeset, rate, makelist FieldsMeta contains the unit information (if we have it) for each field
Supported for these filters: starts-with, not-starts-with, ends-with, not-ends-with, contains, not-contains, eq, ne.
Supported for these filters: and, or, not.
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.
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 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".
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)
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).
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).
Tables hold the result tables in the "tabular" result format
The standard mode of operation for Kirby is to create buckets on the _time column,
Field specifies the field used to create buckets on. Normally this would be _time.
An integer or float representing the fixed bucket size. When the bucket field is _time this value is in nanoseconds.
Columns contain a series of arrays with the raw result data. The columns here line up with the fields in the Fields array.
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.
AggInfo captures information about an aggregation
Args specifies any non-field arguments for the aggregation. Fx. [10] for topk(players, 10).
Fields specifies the names of the fields this aggregation is computed on. Fx ["players"] for topk(players, 10)
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
Groups specifies which grouping operations has been performed on the results.
Name is the name assigned to this table. Defaults to "0". The name "_totals" is reserved for system use.
Order echoes the ordering clauses that was used to sort the results.
End is the ending time the query is limited by. Queries are restricted to the interval [start,end).
Field specifies the field name on which the query range was restricted. Normally _time
Start is the starting time the query is limited by. Queries are restricted to the interval [start,end).
Sources contain the names of the datasets that contributed data to these results.
Was this page helpful?