Run batch query to edge deployment

POST/v1/query/batch

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.

Parameters

Property	Type	Location	Description
`maxConcurrency`	`integer`	`query`	Maximum number of concurrent queries to execute
`nocache`	`boolean`	`query`	Whether to bypass cache for all queries in the batch
`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

Body

application/json

Property	Type	Description
`aplRequest`	`object`
`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
`mplRequest`	`object`
`endTime`	`string`Required	End time for the query range
`mpl`	`string`	The MPL query.
`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)
`queryId`	`string`Required	Unique identifier for this query in the batch

Request

curl -X POST 'https://{axiom-domain}/v1/query/batch' \
  -H 'Authorization: Bearer API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '[{"aplRequest":{"apl":"string","cursor":"string","defaultLimit":0,"defaultOrder":[{"desc":null,"field":null}],"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":{}},"mplRequest":{"endTime":"string","mpl":"string","startTime":"string"},"queryId":"string"}]'

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 RequiredmaxConcurrency querynocache queryapl-source queryapl-source-id queryRequest body application/json

[
  {
    "aplRequest": {
      "apl": "string",
      "cursor": "string",
      "defaultLimit": 0,
      "defaultOrder": [
        {
          "desc": null,
          "field": null
        }
      ],
      "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": {}
    },
    "mplRequest": {
      "endTime": "string",
      "mpl": "string",
      "startTime": "string"
    },
    "queryId": "string"
  }
]

Response

200SSE stream of query results. Each event carries a `kind` field ("apl" or "mpl") indicating how the `data` payload for that queryId should be interpreted.

defaultError

application/json