POST
/
datasets
/
_apl
curl --request POST \
  --url https://api.axiom.co/v1/datasets/_apl \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "apl": "[dataset_name] | limit 10",
  "startTime": "string",
  "endTime": "string"
}'
{
  "buckets": {
    "series": [
      {
        "endTime": "2022-07-26T02:48:46.931Z",
        "groups": [
          {
            "aggregations": [
              {
                "op": "string",
                "value": {}
              }
            ],
            "group": {
              "additionalProp1": {},
              "additionalProp2": {},
              "additionalProp3": {}
            },
            "id": 0
          }
        ],
        "startTime": "2022-07-26T02:48:46.931Z"
      }
    ],
    "totals": [
      {
        "aggregations": [
          {
            "op": "string",
            "value": {}
          }
        ],
        "group": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "id": 0
      }
    ]
  },
  "datasetNames": [
    "string"
  ],
  "fieldsMetaMap": {
    "additionalProp1": [
      {
        "description": "string",
        "hidden": true,
        "name": "string",
        "type": "string",
        "unit": "string"
      }
    ],
    "additionalProp2": [
      {
        "description": "string",
        "hidden": true,
        "name": "string",
        "type": "string",
        "unit": "string"
      }
    ],
    "additionalProp3": [
      {
        "description": "string",
        "hidden": true,
        "name": "string",
        "type": "string",
        "unit": "string"
      }
    ]
  },
  "matches": [
    {
      "_rowId": "string",
      "_sysTime": "2022-07-26T02:48:46.931Z",
      "_time": "2022-07-26T02:48:46.931Z",
      "data": {
        "additionalProp1": {},
        "additionalProp2": {},
        "additionalProp3": {}
      }
    }
  ],
  "request": {
    "aggregations": [
      {
        "alias": "string",
        "argument": {},
        "field": "string",
        "op": "count"
      }
    ],
    "continuationToken": "string",
    "cursor": "string",
    "endTime": "string",
    "fieldsMeta": [
      {
        "description": "string",
        "hidden": true,
        "name": "string",
        "type": "string",
        "unit": "string"
      }
    ],
    "filter": {
      "caseSensitive": true,
      "children": [
        "string"
      ],
      "field": "string",
      "op": "and",
      "value": {}
    },
    "groupBy": [
      "string"
    ],
    "includeCursor": true,
    "limit": 0,
    "order": [
      {
        "desc": true,
        "field": "string"
      }
    ],
    "project": [
      {
        "alias": "string",
        "field": "string"
      }
    ],
    "resolution": "string",
    "startTime": "string",
    "virtualFields": [
      {
        "alias": "string",
        "expr": "string"
      }
    ]
  },
  "status": {
    "blocksExamined": 0,
    "cacheStatus": 0,
    "continuationToken": "string",
    "elapsedTime": 0,
    "isEstimate": true,
    "isPartial": true,
    "maxBlockTime": "2022-07-26T02:48:46.931Z",
    "messages": [
      {
        "code": "string",
        "count": 0,
        "msg": "string",
        "priority": "string"
      }
    ],
    "minBlockTime": "2022-07-26T02:48:46.931Z",
    "numGroups": 0,
    "rowsExamined": 0,
    "rowsMatched": 0
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

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

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

Body

application/json

Response

200
application/json
Successful APL result

The response is of type object.