Authorizations
API key passed in the header
Path Parameters
The unique identifier of the batch
Response
Batch status retrieved successfully
curl --request GET \
--url https://api.anchorbrowser.io/v1/batch-sessions/{batch_id} \
--header 'anchor-api-key: <api-key>'
{
"data": {
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"total_requests": 123,
"completed_requests": 123,
"failed_requests": 123,
"processing_requests": 123,
"pending_requests": 123,
"created_at": "2023-11-07T05:31:56Z",
"actual_completion_time": "2023-11-07T05:31:56Z",
"error": "<string>",
"sessions": [
{
"item_index": 123,
"session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"cdp_url": "<string>",
"live_view_url": "<string>",
"error": "<string>",
"retry_count": 123,
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"progress": {
"percentage": 50,
"current_phase": "queued"
}
}
}
Retrieves detailed status information for a specific batch, including progress, individual session details, and any errors that occurred.
curl --request GET \
--url https://api.anchorbrowser.io/v1/batch-sessions/{batch_id} \
--header 'anchor-api-key: <api-key>'
{
"data": {
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"total_requests": 123,
"completed_requests": 123,
"failed_requests": 123,
"processing_requests": 123,
"pending_requests": 123,
"created_at": "2023-11-07T05:31:56Z",
"actual_completion_time": "2023-11-07T05:31:56Z",
"error": "<string>",
"sessions": [
{
"item_index": 123,
"session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"cdp_url": "<string>",
"live_view_url": "<string>",
"error": "<string>",
"retry_count": 123,
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"progress": {
"percentage": 50,
"current_phase": "queued"
}
}
}
API key passed in the header
The unique identifier of the batch
Batch status retrieved successfully
Show child attributes
Was this page helpful?