Run APL query to edge deployment

POST/v1/query/_apl?format=tabular

Warning

Use this endpoint to query data from a specific edge deployment. The data you query must be stored in the edge deployment where you query it. For more information, see Query data and Edge deployments.

The base domain for this endpoint is the base domain of the edge deployment where you want to query data.

Edge deployment	Base domain for ingest and query
`US East 1 (AWS)`	`us-east-1.aws.edge.axiom.co`
`EU Central 1 (AWS)`	`eu-central-1.aws.edge.axiom.co`

This endpoint only supports API tokens. Personal access tokens (PATs) aren't supported. For more information, see Tokens.

This is the edge equivalent of the standard Run query endpoint. Send the request to your edge deployment's base domain at the path /v1/query/_apl. The standard /v1/datasets/_apl path isn't served on edge domains, so requests to it return a 404.

If you use an Axiom SDK, set the edge option on the client and it sends queries to this endpoint automatically. For more information, see Configure region.

Parameters

Property	Type	Location	Description
`format`	`string`Required	`query`
`nocache`	`boolean`	`query`
`saveAsKind`	`string`	`query`
`id`	`string`	`query`	when saveAsKind is true, this parameter indicates the id of the associated dataset
`streaming-duration`	`string`	`query`
`apl-source`	`string`	`query`	contains the source of the APL query (for example console, dashboard, etc.)
`apl-source-id`	`string`	`query`	contains the id of the source, for example dashboard_id
`totals`	`boolean`	`query`	Include a totals table (only supported in MetricsDB)

Body

application/json

Property	Type	Description
`apl`	`string`Required	APL query string
`cursor`	`string`	Pagination cursor
`defaultLimit`	`integer`	The default limit to use when no limit is specified in the query.
`defaultOrder`	`object[]`	The default order to use when no order is specified in the query.
`desc`	`boolean`
`field`	`string`
`endTime`	`string`	End time for the query range
`includeCursor`	`boolean`	Include cursor in response
`includeCursorField`	`boolean`	Defines if the _cursor field should be projected in the result
`libraries`	`string[]`
`maxBinAutoGroups`	`integer`	Maximum number of groups to automatically bin into
`queryOptions`	`object`
`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`
`nanosecondPrecision`	`string`
`openIntervals`	`string`
`overlayCharts`	`string`
`queryObject`	`string`
`quickRange`	`string`
`resolution`	`string`
`resultsHistogram`	`string`
`selection`	`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

Request

curl -X POST 'https://{axiom-domain}/v1/query/_apl?format=tabular' \
  -H 'Authorization: Bearer API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"apl":"string","cursor":"string","defaultLimit":0,"defaultOrder":[{"desc":true,"field":"string"}],"endTime":"string","includeCursor":true,"includeCursorField":true,"libraries":["string"],"maxBinAutoGroups":0,"queryOptions":{"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","nanosecondPrecision":"string","openIntervals":"string","overlayCharts":"string","queryObject":"string","quickRange":"string","resolution":"string","resultsHistogram":"string","selection":"string","shownColumns":"string","startColumn":"string","startLineNumber":"string","startTime":"string","timeSeriesVariant":"string","timeSeriesView":"string"},"startTime":"string","variables":{}}'

Try itRun this request against your Axiom organization

Credentials stay in this browser tab and are only sent to Axiom when you run the request.

API token Requiredformat queryRequirednocache querysaveAsKind queryid querystreaming-duration queryapl-source queryapl-source-id querytotals queryRequest body application/json

{
  "apl": "string",
  "cursor": "string",
  "defaultLimit": 0,
  "defaultOrder": [
    {
      "desc": true,
      "field": "string"
    }
  ],
  "endTime": "string",
  "includeCursor": true,
  "includeCursorField": true,
  "libraries": [
    "string"
  ],
  "maxBinAutoGroups": 0,
  "queryOptions": {
    "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",
    "nanosecondPrecision": "string",
    "openIntervals": "string",
    "overlayCharts": "string",
    "queryObject": "string",
    "quickRange": "string",
    "resolution": "string",
    "resultsHistogram": "string",
    "selection": "string",
    "shownColumns": "string",
    "startColumn": "string",
    "startLineNumber": "string",
    "startTime": "string",
    "timeSeriesVariant": "string",
    "timeSeriesView": "string"
  },
  "startTime": "string",
  "variables": {}
}

Response

200AplResult

application/json

defaultUser or system error

application/json