Query

post
/v1/datasets/_apl

Query Parameters

ParamTypeDescription

format

string

required

values:legacytabular

nocache

boolean

saveAsKind

string

id

string

when saveAsKind is true, this parameter indicates the id of the associated dataset

Body Parameters

ParamTypeDescription

apl

string

required

cursor

string

endTime

string

includeCursor

boolean

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>

startTime

string

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

object

Variables is an optional set of additional variables that are inserted into the APL

Responses

200
Successful APL result, an object with the following properties:
PropertyTypeDescription

buckets

object

Properties

series <array>

totals <array>

datasetNames

array

fieldsMetaMap

object

FieldsMetaMap contains the unit information (if we have it) for each field in the given dataset entry

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

request

object

required
Properties

aggregations <array>

continuationToken <string>

cursor <string>

endTime <string>

fieldsMeta <array>

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

filter <object>

groupBy <array>

includeCursor <boolean>

limit <integer>

order <array>

project <array>

resolution <string>

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>

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)

virtualFields <array>

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?