Skip to main content
POST
/
query
/
_apl?format=tabular
cURL
curl --request POST \
  --url 'https://{axiom-domain}/v1/query/_apl?format=tabular' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "apl": "<string>",
  "cursor": "<string>",
  "defaultLimit": 123,
  "defaultOrder": [
    {
      "desc": true,
      "field": "<string>"
    }
  ],
  "endTime": "<string>",
  "includeCursor": true,
  "includeCursorField": true,
  "libraries": [
    "<string>"
  ],
  "maxBinAutoGroups": 123,
  "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": {}
}
'
import requests

url = "https://{axiom-domain}/v1/query/_apl?format=tabular"

payload = {
    "apl": "<string>",
    "cursor": "<string>",
    "defaultLimit": 123,
    "defaultOrder": [
        {
            "desc": True,
            "field": "<string>"
        }
    ],
    "endTime": "<string>",
    "includeCursor": True,
    "includeCursorField": True,
    "libraries": ["<string>"],
    "maxBinAutoGroups": 123,
    "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": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    apl: '<string>',
    cursor: '<string>',
    defaultLimit: 123,
    defaultOrder: [{desc: true, field: '<string>'}],
    endTime: '<string>',
    includeCursor: true,
    includeCursorField: true,
    libraries: ['<string>'],
    maxBinAutoGroups: 123,
    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: {}
  })
};

fetch('https://{axiom-domain}/v1/query/_apl?format=tabular', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{axiom-domain}/v1/query/_apl?format=tabular",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'apl' => '<string>',
    'cursor' => '<string>',
    'defaultLimit' => 123,
    'defaultOrder' => [
        [
                'desc' => true,
                'field' => '<string>'
        ]
    ],
    'endTime' => '<string>',
    'includeCursor' => true,
    'includeCursorField' => true,
    'libraries' => [
        '<string>'
    ],
    'maxBinAutoGroups' => 123,
    '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' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{axiom-domain}/v1/query/_apl?format=tabular"

	payload := strings.NewReader("{\n  \"apl\": \"<string>\",\n  \"cursor\": \"<string>\",\n  \"defaultLimit\": 123,\n  \"defaultOrder\": [\n    {\n      \"desc\": true,\n      \"field\": \"<string>\"\n    }\n  ],\n  \"endTime\": \"<string>\",\n  \"includeCursor\": true,\n  \"includeCursorField\": true,\n  \"libraries\": [\n    \"<string>\"\n  ],\n  \"maxBinAutoGroups\": 123,\n  \"queryOptions\": {\n    \"against\": \"<string>\",\n    \"againstStart\": \"<string>\",\n    \"againstTimestamp\": \"<string>\",\n    \"aggChartOpts\": \"<string>\",\n    \"caseSensitive\": \"<string>\",\n    \"containsTimeFilter\": \"<string>\",\n    \"datasets\": \"<string>\",\n    \"displayNull\": \"<string>\",\n    \"editorContent\": \"<string>\",\n    \"endColumn\": \"<string>\",\n    \"endLineNumber\": \"<string>\",\n    \"endTime\": \"<string>\",\n    \"integrationsFilter\": \"<string>\",\n    \"nanosecondPrecision\": \"<string>\",\n    \"openIntervals\": \"<string>\",\n    \"overlayCharts\": \"<string>\",\n    \"queryObject\": \"<string>\",\n    \"quickRange\": \"<string>\",\n    \"resolution\": \"<string>\",\n    \"resultsHistogram\": \"<string>\",\n    \"selection\": \"<string>\",\n    \"shownColumns\": \"<string>\",\n    \"startColumn\": \"<string>\",\n    \"startLineNumber\": \"<string>\",\n    \"startTime\": \"<string>\",\n    \"timeSeriesVariant\": \"<string>\",\n    \"timeSeriesView\": \"<string>\"\n  },\n  \"startTime\": \"<string>\",\n  \"variables\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://{axiom-domain}/v1/query/_apl?format=tabular")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"apl\": \"<string>\",\n  \"cursor\": \"<string>\",\n  \"defaultLimit\": 123,\n  \"defaultOrder\": [\n    {\n      \"desc\": true,\n      \"field\": \"<string>\"\n    }\n  ],\n  \"endTime\": \"<string>\",\n  \"includeCursor\": true,\n  \"includeCursorField\": true,\n  \"libraries\": [\n    \"<string>\"\n  ],\n  \"maxBinAutoGroups\": 123,\n  \"queryOptions\": {\n    \"against\": \"<string>\",\n    \"againstStart\": \"<string>\",\n    \"againstTimestamp\": \"<string>\",\n    \"aggChartOpts\": \"<string>\",\n    \"caseSensitive\": \"<string>\",\n    \"containsTimeFilter\": \"<string>\",\n    \"datasets\": \"<string>\",\n    \"displayNull\": \"<string>\",\n    \"editorContent\": \"<string>\",\n    \"endColumn\": \"<string>\",\n    \"endLineNumber\": \"<string>\",\n    \"endTime\": \"<string>\",\n    \"integrationsFilter\": \"<string>\",\n    \"nanosecondPrecision\": \"<string>\",\n    \"openIntervals\": \"<string>\",\n    \"overlayCharts\": \"<string>\",\n    \"queryObject\": \"<string>\",\n    \"quickRange\": \"<string>\",\n    \"resolution\": \"<string>\",\n    \"resultsHistogram\": \"<string>\",\n    \"selection\": \"<string>\",\n    \"shownColumns\": \"<string>\",\n    \"startColumn\": \"<string>\",\n    \"startLineNumber\": \"<string>\",\n    \"startTime\": \"<string>\",\n    \"timeSeriesVariant\": \"<string>\",\n    \"timeSeriesView\": \"<string>\"\n  },\n  \"startTime\": \"<string>\",\n  \"variables\": {}\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://{axiom-domain}/v1/query/_apl?format=tabular")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"apl\": \"<string>\",\n  \"cursor\": \"<string>\",\n  \"defaultLimit\": 123,\n  \"defaultOrder\": [\n    {\n      \"desc\": true,\n      \"field\": \"<string>\"\n    }\n  ],\n  \"endTime\": \"<string>\",\n  \"includeCursor\": true,\n  \"includeCursorField\": true,\n  \"libraries\": [\n    \"<string>\"\n  ],\n  \"maxBinAutoGroups\": 123,\n  \"queryOptions\": {\n    \"against\": \"<string>\",\n    \"againstStart\": \"<string>\",\n    \"againstTimestamp\": \"<string>\",\n    \"aggChartOpts\": \"<string>\",\n    \"caseSensitive\": \"<string>\",\n    \"containsTimeFilter\": \"<string>\",\n    \"datasets\": \"<string>\",\n    \"displayNull\": \"<string>\",\n    \"editorContent\": \"<string>\",\n    \"endColumn\": \"<string>\",\n    \"endLineNumber\": \"<string>\",\n    \"endTime\": \"<string>\",\n    \"integrationsFilter\": \"<string>\",\n    \"nanosecondPrecision\": \"<string>\",\n    \"openIntervals\": \"<string>\",\n    \"overlayCharts\": \"<string>\",\n    \"queryObject\": \"<string>\",\n    \"quickRange\": \"<string>\",\n    \"resolution\": \"<string>\",\n    \"resultsHistogram\": \"<string>\",\n    \"selection\": \"<string>\",\n    \"shownColumns\": \"<string>\",\n    \"startColumn\": \"<string>\",\n    \"startLineNumber\": \"<string>\",\n    \"startTime\": \"<string>\",\n    \"timeSeriesVariant\": \"<string>\",\n    \"timeSeriesView\": \"<string>\"\n  },\n  \"startTime\": \"<string>\",\n  \"variables\": {}\n}"

response = http.request(request)
puts response.read_body
{}
{
  "code": 123,
  "detail": {
    "column": 123,
    "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 deploymentBase 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.

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

​
format
enum<string>
required
Available options:
legacy,
tabular,
tabular-rows
​
nocache
boolean
default:false
​
saveAsKind
string
​
id
string

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

​
streaming-duration
string
​
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

​
totals
boolean

Include a totals table (only supported in MetricsDB)

Body

application/json
​
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.

​
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[]

library ids to include in this query

​
maxBinAutoGroups
integer

Maximum number of groups to automatically bin into

​
queryOptions
object
​
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

Response

AplResult

APL query result (streaming binary data)