Documentation Index

Fetch the complete documentation index at: https://docs.supermetrics.com/llms.txt

Use this file to discover all available pages before exploring further.

Get batch status

  • Updated on Jun 17, 2026
  • Published on Dec 12, 2025
Prev
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

Expand All
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*
{
  "meta": {
    "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
  },
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication is required."
  }
}
Expand All
object

Standard envelope returned by all error (4xx/5xx) responses.

meta
object (CommonSchemas_Meta)

Metadata included in every API response.

request_id
string

Unique identifier for the request, for tracking and debugging.

Min length8
Max length64
Pattern^[A-Za-z0-9_-]+$
ExampleBXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN
error
object (ErrorResponse_Error)

Machine- and human-readable detail for a failed request.

code
string

Stable, screaming-snake-case identifier for the error condition. Clients should branch on this, not on message. Common values include BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT_ERROR, PERMISSION_ERROR, UNPROCESSABLE_ENTITY, UNPROCESSABLE_CONTENT, TOO_MANY_REQUESTS, INTERNAL_SERVER_ERROR, DUPLICATION_FAILED, SERVICE_UNAVAILABLE; domains may define additional codes.

Max length100
Pattern^[A-Z][A-Z0-9_]*$
ExampleBAD_REQUEST
message
string

Short, human-readable summary of the error.

Max length255
Pattern^.+$
ExampleThe request was invalid.
description
string

Optional longer explanation specific to this occurrence.

Max length2048
ExampleThe field 'display_name' must not be empty.
404

Batch not found

© Supermetrics 2025