Get query

Prev Next
Get
/query/{query_id}

Get details of a specific saved query

Security
HTTP
Type bearer

Bearer token authentication. Include the token in the Authorization header: Authorization: Bearer <your-token>

Path parameters
query_id
stringRequired

Supermetrics query ID

Responses
200

Query details retrieved successfully

Expand All
object
meta
object
request_id
string

API request ID

data
object (Query)
@type
string
Valid values[ "query" ]
query_id
string

Supermetrics query ID

slug
string

Unique query slug string, used in query's short URL

name
string

Custom query name

ds_info
object (DataSource)
@type
string
Valid values[ "ds" ]
ds_id
string

Data source ID

name
string

Data source name

group_info
object (QueryGroup)
@type
string
Valid values[ "query_group" ]
group_id
string

Supermetrics query group ID

name
string

Query group name

query_params
object

Query parameters in key-value pairs, as expected by the get data endpoint

404

Query Not Found

object
error
string
Valid values[ "QUERY_NOT_FOUND" ]
message
string