Skip to main content
GET
Retrieve a custom result query

Authorizations

Authorization
string
header
required

Bearer tokens created in the ABConvert admin under Settings → MCP & API Access. Scopes: read_experiments and write_experiments (write implies read; the default is read). See Authentication for which scope each request needs.

Path Parameters

id
string
required

The test's numeric ID as a string, for example "3021".

Pattern: ^[0-9]+$
Example:

"3021"

query_id
string
required

Response

The query, completed or failed.

A custom result query job. Beta.

status is pending until the snapshot is computed, then completed or failed. The result fields are present only when completed.

object
string
required
Allowed value: "results_query"
id
string
required

Treat as opaque. Never parse it.

Example:

"66d3b91c4f2a7e5081c9a3b7"

experiment_id
string
required
Example:

"3021"

status
enum<string>
required
Available options:
pending,
completed,
failed
failure_reason
string | null

Why the query failed, in plain language. Present only when status is failed. Run the query again; if it fails again, send support this text and the query id.

computed_at
string<date-time> | null
metric_set
enum<string>

The registry used to compute these rows.

Available options:
core,
engagement
customEvents
object[]

Custom-event analytics already computed in the snapshot.

warnings
string[]
filterStale
boolean
isRefreshing
boolean
date_range
object | null

The effective inclusive local-date window after safety clamping.

test_groups
object[]

Whole-test totals. Present on a query with no breakdown; a dimensional query answers with breakdown.rows instead, and carries no separate totals.

breakdown
object | null

Present when the query named a breakdown.