Run an analytics query

curl --request POST \
  --url https://api.burthq.com/api/v1/analytics/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "agent_runs",
  "metrics": [
    "run_count",
    "completed_run_count",
    "failed_run_count"
  ],
  "dimensions": [],
  "filters": [],
  "range": {
    "start": "2026-08-01",
    "end": "2026-08-14",
    "timezone": "UTC"
  },
  "order": [],
  "limit": 100
}
'

import requests

url = "https://api.burthq.com/api/v1/analytics/query"

payload = {
    "model": "agent_runs",
    "metrics": ["run_count", "completed_run_count", "failed_run_count"],
    "dimensions": [],
    "filters": [],
    "range": {
        "start": "2026-08-01",
        "end": "2026-08-14",
        "timezone": "UTC"
    },
    "order": [],
    "limit": 100
}
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({
    model: 'agent_runs',
    metrics: ['run_count', 'completed_run_count', 'failed_run_count'],
    dimensions: [],
    filters: [],
    range: {start: '2026-08-01', end: '2026-08-14', timezone: 'UTC'},
    order: [],
    limit: 100
  })
};

fetch('https://api.burthq.com/api/v1/analytics/query', 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://api.burthq.com/api/v1/analytics/query",
  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([
    'model' => 'agent_runs',
    'metrics' => [
        'run_count',
        'completed_run_count',
        'failed_run_count'
    ],
    'dimensions' => [
        
    ],
    'filters' => [
        
    ],
    'range' => [
        'start' => '2026-08-01',
        'end' => '2026-08-14',
        'timezone' => 'UTC'
    ],
    'order' => [
        
    ],
    'limit' => 100
  ]),
  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://api.burthq.com/api/v1/analytics/query"

	payload := strings.NewReader("{\n  \"model\": \"agent_runs\",\n  \"metrics\": [\n    \"run_count\",\n    \"completed_run_count\",\n    \"failed_run_count\"\n  ],\n  \"dimensions\": [],\n  \"filters\": [],\n  \"range\": {\n    \"start\": \"2026-08-01\",\n    \"end\": \"2026-08-14\",\n    \"timezone\": \"UTC\"\n  },\n  \"order\": [],\n  \"limit\": 100\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://api.burthq.com/api/v1/analytics/query")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": \"agent_runs\",\n  \"metrics\": [\n    \"run_count\",\n    \"completed_run_count\",\n    \"failed_run_count\"\n  ],\n  \"dimensions\": [],\n  \"filters\": [],\n  \"range\": {\n    \"start\": \"2026-08-01\",\n    \"end\": \"2026-08-14\",\n    \"timezone\": \"UTC\"\n  },\n  \"order\": [],\n  \"limit\": 100\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.burthq.com/api/v1/analytics/query")

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  \"model\": \"agent_runs\",\n  \"metrics\": [\n    \"run_count\",\n    \"completed_run_count\",\n    \"failed_run_count\"\n  ],\n  \"dimensions\": [],\n  \"filters\": [],\n  \"range\": {\n    \"start\": \"2026-08-01\",\n    \"end\": \"2026-08-14\",\n    \"timezone\": \"UTC\"\n  },\n  \"order\": [],\n  \"limit\": 100\n}"

response = http.request(request)
puts response.read_body

{
  "queryId": "550e8400-e29b-41d4-a716-446655440000",
  "catalogVersion": "2026-08-24.2",
  "asOf": "2026-08-21T00:00:00.000Z",
  "range": {
    "start": "2026-08-01",
    "end": "2026-08-14",
    "timezone": "UTC",
    "startUtc": "2026-08-01T00:00:00.000Z",
    "endUtc": "2026-08-15T00:00:00.000Z"
  },
  "columns": [
    {
      "name": "run_count",
      "type": "number",
      "member": "run_count"
    },
    {
      "name": "completed_run_count",
      "type": "number",
      "member": "completed_run_count"
    },
    {
      "name": "failed_run_count",
      "type": "number",
      "member": "failed_run_count"
    }
  ],
  "rows": [
    [
      25,
      17,
      4
    ]
  ],
  "cursor": null,
  "warnings": []
}

POST

api

analytics

query

Run an analytics query

curl --request POST \
  --url https://api.burthq.com/api/v1/analytics/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "agent_runs",
  "metrics": [
    "run_count",
    "completed_run_count",
    "failed_run_count"
  ],
  "dimensions": [],
  "filters": [],
  "range": {
    "start": "2026-08-01",
    "end": "2026-08-14",
    "timezone": "UTC"
  },
  "order": [],
  "limit": 100
}
'

import requests

url = "https://api.burthq.com/api/v1/analytics/query"

payload = {
    "model": "agent_runs",
    "metrics": ["run_count", "completed_run_count", "failed_run_count"],
    "dimensions": [],
    "filters": [],
    "range": {
        "start": "2026-08-01",
        "end": "2026-08-14",
        "timezone": "UTC"
    },
    "order": [],
    "limit": 100
}
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({
    model: 'agent_runs',
    metrics: ['run_count', 'completed_run_count', 'failed_run_count'],
    dimensions: [],
    filters: [],
    range: {start: '2026-08-01', end: '2026-08-14', timezone: 'UTC'},
    order: [],
    limit: 100
  })
};

fetch('https://api.burthq.com/api/v1/analytics/query', 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://api.burthq.com/api/v1/analytics/query",
  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([
    'model' => 'agent_runs',
    'metrics' => [
        'run_count',
        'completed_run_count',
        'failed_run_count'
    ],
    'dimensions' => [
        
    ],
    'filters' => [
        
    ],
    'range' => [
        'start' => '2026-08-01',
        'end' => '2026-08-14',
        'timezone' => 'UTC'
    ],
    'order' => [
        
    ],
    'limit' => 100
  ]),
  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://api.burthq.com/api/v1/analytics/query"

	payload := strings.NewReader("{\n  \"model\": \"agent_runs\",\n  \"metrics\": [\n    \"run_count\",\n    \"completed_run_count\",\n    \"failed_run_count\"\n  ],\n  \"dimensions\": [],\n  \"filters\": [],\n  \"range\": {\n    \"start\": \"2026-08-01\",\n    \"end\": \"2026-08-14\",\n    \"timezone\": \"UTC\"\n  },\n  \"order\": [],\n  \"limit\": 100\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://api.burthq.com/api/v1/analytics/query")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": \"agent_runs\",\n  \"metrics\": [\n    \"run_count\",\n    \"completed_run_count\",\n    \"failed_run_count\"\n  ],\n  \"dimensions\": [],\n  \"filters\": [],\n  \"range\": {\n    \"start\": \"2026-08-01\",\n    \"end\": \"2026-08-14\",\n    \"timezone\": \"UTC\"\n  },\n  \"order\": [],\n  \"limit\": 100\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.burthq.com/api/v1/analytics/query")

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  \"model\": \"agent_runs\",\n  \"metrics\": [\n    \"run_count\",\n    \"completed_run_count\",\n    \"failed_run_count\"\n  ],\n  \"dimensions\": [],\n  \"filters\": [],\n  \"range\": {\n    \"start\": \"2026-08-01\",\n    \"end\": \"2026-08-14\",\n    \"timezone\": \"UTC\"\n  },\n  \"order\": [],\n  \"limit\": 100\n}"

response = http.request(request)
puts response.read_body

{
  "queryId": "550e8400-e29b-41d4-a716-446655440000",
  "catalogVersion": "2026-08-24.2",
  "asOf": "2026-08-21T00:00:00.000Z",
  "range": {
    "start": "2026-08-01",
    "end": "2026-08-14",
    "timezone": "UTC",
    "startUtc": "2026-08-01T00:00:00.000Z",
    "endUtc": "2026-08-15T00:00:00.000Z"
  },
  "columns": [
    {
      "name": "run_count",
      "type": "number",
      "member": "run_count"
    },
    {
      "name": "completed_run_count",
      "type": "number",
      "member": "completed_run_count"
    },
    {
      "name": "failed_run_count",
      "type": "number",
      "member": "failed_run_count"
    }
  ],
  "rows": [
    [
      25,
      17,
      4
    ]
  ],
  "cursor": null,
  "warnings": []
}

Authorizations

Authorization

string

header

required

Organization API key with the analytics:read scope.

Headers

x-request-id

string

Optional caller-supplied request ID. Values must contain 1–64 ASCII letters, digits, or ._:/=-; invalid values are replaced with a generated UUID.

Required string length: 1 - 64

Pattern: ^[A-Za-z0-9._:/=-]+$

Body

application/json

model

enum<string>

required

Catalog model name. The current catalog supports agent_runs and agent_user_activity.

Available options:

agent_runs,

agent_user_activity

Required string length: 1 - 64

metrics

string[]

required

Unique catalog metric names to select.

Required array length: 1 - 16 elements

Required string length: 1 - 64

range

object

required

Show child attributes

dimensions

string[]

Unique catalog dimensions to group by.

Maximum array length: 8

Required string length: 1 - 64

filters

object[]

Dimension filters: eq with one value, or in with 1–50 values.

Maximum array length: 8

Option 1
Option 2

Show child attributes

order

object[]

Up to eight unique order terms. Members must be selected metrics or dimensions. Totals queries cannot specify order terms.

Maximum array length: 8

Show child attributes

limit

integer

default:100

Maximum rows returned per page.

Required range: 1 <= x <= 500

cursor

string

Opaque continuation cursor from a previous grouped response. Not accepted on totals or metric-ordered queries.

Required string length: 1 - 2048

Response

Columnar query results.

queryId

string<uuid>

required

Unique identifier for this execution.

catalogVersion

string

required

Catalog version used to produce this response.

asOf

string<date-time>

required

Inclusion boundary used for this response and any cursor continuation.

range

object

required

Show child attributes

columns

object[]

required

Ordered column descriptors; a selected dimension is followed by its companions, then metrics.

Show child attributes

rows

((string | number | enum<string> | null)[])[]

required

Values in the same order as columns.

cursor

string | null

required

Continuation cursor for the next page, or null when there is no next page.

warnings

object[]

required

Non-fatal semantic notices.

Show child attributes

Getting Started

API Guides

Analytics

Run an analytics query

Authorizations

Headers

Body

Response