Get
/query/batch/{batch_id}/status
Retrieve the current status of a batch query and its individual queries.
Security
HTTP
Type bearer
Bearer token authentication. Include the token in the Authorization header:
Authorization: Bearer <your-token>
Path parameters
batch_id
stringRequired
Supermetrics query batch ID
Query parameters
offset
integer
Pagination offset for the number of queries to return
Minimum0
Default0
limit
integer
Maximum number of queries to return
Minimum1
Maximum1000
Default100
Responses
200
Batch status retrieved successfully
object
meta
object
request_id
string
status_code
string
progress
object
queued
integer
running
integer
success
integer
failure
integer
paginate
object
offset
integer
limit
integer
total
integer
data
Array of object (BatchQuery)
object
@type
string
Valid values[
"batch_query"
]
schedule_id
string
status_code
string
Valid values[
"QUEUED",
"RUNNING",
"SUCCESS",
"FAILURE"
]
query_start_time
string (date-time)
query_end_time
string (date-time) | null
split_info
object (BatchQuerySplit)
ds_accounts
Array of string
string
start_date
string (date) | null
end_date
string (date) | null
error_info
object (Error)
status
integer
code
string
message
string
description
string
result_info
object (BatchQueryResult)
total_rows
integer
results_url
string
401
Unauthorized
Headers
WWW-Authenticate
string
Bearer token required
Max length255
Pattern^Bearer.*
X-RateLimit-Limit
integer
Request limit per hour
Minimum1
Maximum10000
Example5000
X-RateLimit-Remaining
integer
Remaining requests in current window
Minimum0
Maximum10000
Example4999
Access-Control-Allow-Origin
string
CORS header
Valid values[
"*"
]
Max length255
Example*
object
RFC 9457 Problem Details for HTTP APIs
type
string (uri)
A URI reference that identifies the problem type
Max length255
Examplehttps://supermetrics.com/problems/unauthorized
title
string
A short, human-readable summary of the problem type
Max length255
Pattern^[A-Za-z0-9\s]+$
ExampleUnauthorized
status
integer (int32)
The HTTP status code
Minimum100
Maximum599
Example401
detail
string
A human-readable explanation specific to this occurrence
Max length1000
Pattern^[A-Za-z0-9\s.,\-]+$
ExampleAuthentication required
instance
string (uri)
A URI reference that identifies the specific occurrence
Max length255
Examplehttps://api.supermetrics.com/v2/api-keys
404
Batch not found