Querying API
Use Axiom querying API to create and get query objects.
Authorization and Headers
The only expected headers are the Authorization: Bearer, which is your API or Personal Token, and X-Axiom-Org-ID, which is your organization id. Learn more about API Token and Org ID.
Request Example
POST api.axiom.co/v1/datasets/\{id\}/query
curl -X 'POST' \
'https://api.axiom.co/v1/datasets/<dataset_id>/query?saveAsKind=<save_as_kind_query>&streaming-duration=<streaming_duration>&nocache=true' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <$API_TOKEN or $PERSONAL_TOKEN>' \
-H 'X-Axiom-Org-ID: <$ORG_ID>' \
-d '{
"aggregations": [
{
"alias": "string",
"argument": {},
"field": "string",
"op": "count"
}
],
"continuationToken": "string",
"cursor": "string",
"endTime": "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"
}
],
"queryOptions": {
"against": "string",
"againstStart": "string",
"againstTimestamp": "string",
"caseSensitive": "string",
"containsTimeFilter": "string",
"datasets": "string",
"displayNull": "string",
"editorContent": "string",
"endColumn": "string",
"endLineNumber": "string",
"endTime": "string",
"integrationsFilter": "string",
"openIntervals": "string",
"quickRange": "string",
"resolution": "string",
"startColumn": "string",
"startLineNumber": "string",
"startTime": "string",
"timeSeriesView": "string"
},
"resolution": "string",
"startTime": "string",
"virtualFields": [
{
"alias": "string",
"expr": "string"
}
]
}'Response Example
Response code 200 and the response body:
{
"buckets": {
"series": [
{
"endTime": "2022-07-26T03:00:48.925Z",
"groups": [
{
"aggregations": [
{
"op": "string",
"value": {}
}
],
"group": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"id": 0
}
],
"startTime": "2022-07-26T03:00:48.925Z"
}
],
"totals": [
{
"aggregations": [
{
"op": "string",
"value": {}
}
],
"group": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"id": 0
}
]
},
"fieldsMeta": [
{
"description": "string",
"hidden": true,
"name": "string",
"type": "string",
"unit": "string"
}
],
"matches": [
{
"_rowId": "string",
"_sysTime": "2022-07-26T03:00:48.925Z",
"_time": "2022-07-26T03:00:48.925Z",
"data": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
}
],
"status": {
"blocksExamined": 0,
"cacheStatus": 0,
"continuationToken": "string",
"elapsedTime": 0,
"isEstimate": true,
"isPartial": true,
"maxBlockTime": "2022-07-26T03:00:48.925Z",
"messages": [
{
"code": "string",
"count": 0,
"msg": "string",
"priority": "string"
}
],
"minBlockTime": "2022-07-26T03:00:48.925Z",
"numGroups": 0,
"rowsExamined": 0,
"rowsMatched": 0
}
}
