Run batch query to edge deployment

POST /query/batch

cURL

cURL

curl --request POST \
  --url https://{axiom-domain}/v1/query/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "queryId": "<string>"
  }
]
'

default

{
  "code": 123,
  "detail": {
    "column": 123,
    "compileErrorCode": 1,
    "errorType": 1,
    "line": 123,
    "message": "<string>"
  },
  "message": "<string>"
}

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.

Authorizations

Authorization · string · header · required

Authenticate using an API token or personal access token (PAT). Include the token as a Bearer token: Authorization: Bearer <token>. For more information, see Tokens.

Query Parameters

maxConcurrency · integer · default: 10

Maximum number of concurrent queries to execute

Required range: 1 <= x <= 20

nocache · boolean · default: false

Whether to bypass cache for all queries in the batch

apl-source · string

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

apl-source-id · string

Contains the id of the source, for example dashboard_id

Body

application/json

queryId · string · required

Unique identifier for this query in the batch

aplRequest · object

Show child attributes

Response

200

SSE stream of query results