Get query history

Prev Next
Get
/query/history

Get list of upcoming, running and performed queries from given time range

Security
HTTP
Type bearer

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

Query parameters
json
Required
object
api_key
string

API key when not using an authorization header

ds_ids

Target data source IDs (case-insensitive)

OneOf
string
string
array
array
string
status_codes

Target query status codes (case-insensitive)

OneOf
string
string
array
array
string
since
string

Return queries requested after given ISO 8601 datetime, date, or relative time (default 24 hours ago, max 90 days)

until
string

Return queries requested before given ISO 8601 datetime, date, or relative time (defaults to current time)

offset
integer

Pagination offset

Default0
limit
integer

Maximum number of queries to return

Maximum1000
Default100
Responses
200

Query history retrieved successfully

Expand All
object
meta
object
request_id
string

API request ID

filter
object
since
string (date-time)

Used start time

until
string (date-time)

Used end time

paginate
object
offset
integer

Used pagination offset

limit
integer

Used pagination limit

total
integer

Total number of queries found within time range

data
Array of object
object
@type
string

Object type

Valid values[ "query_history" ]
schedule_time
string (date-time)

When query was requested

schedule_id
string

Query schedule ID

status_code
string

Current query status code

app_id
string

Supermetrics product used to perform the query

Valid values[ "API" ]
ds_id
string

Query data source ID

total_rows
integer | null

Number of result rows (only for SUCCESS and FAILURE status)

run_seconds
number (float) | null

Query execution time in seconds (only for SUCCESS and FAILURE status)