AXaxiom
query

POST /query/_apl?format=tabular

Changed on

Runs an APL query against datasets in this edge deployment and returns the result in the requested format. Returns 429 when an organization, token, or user query cost limit is exhausted.

Request

Query parameters

format'legacy' | 'tabular' | 'tabular-rows' required
nocacheboolean
saveAsKindstring
idstring

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

streaming-durationstring
apl-sourcestring

contains the source of the APL query (for example console, dashboard, etc.)

apl-source-idstring

contains the id of the source, for example dashboard_id

totalsboolean

Include a totals table (only supported in MetricsDB)

Request body

aplstring required

APL query string

cursorstring

Pagination cursor

defaultLimitinteger

The default limit to use when no limit is specified in the query.

endTimestring

End time for the query range

includeCursorboolean

Include cursor in response

includeCursorFieldboolean

Defines if the _cursor field should be projected in the result

librariesstring[]
maxBinAutoGroupsinteger

Maximum number of groups to automatically bin into

startTimestring

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)

variablesobject

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

Response

Query result in the requested format.

AplResult required

APL query result (streaming binary data)

Changes

  • 16be903874f4Revision changes
    • warning

      the optional response header X-QueryLimit-Limit removed for the status 200

    • warning

      the optional response header X-QueryLimit-Remaining removed for the status 200

    • warning

      the optional response header X-QueryLimit-Reset removed for the status 200

    • info

      added the non-success response with the status