Skip to main content
GET
/
v1
/
batch-sessions
List Batch Sessions
curl --request GET \
  --url https://api.anchorbrowser.io/v1/batch-sessions \
  --header 'anchor-api-key: <api-key>'
{
  "data": {
    "batches": [
      {
        "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "status": "pending",
        "total_requests": 123,
        "completed_requests": 123,
        "failed_requests": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "actual_completion_time": "2023-11-07T05:31:56Z"
      }
    ],
    "pagination": {
      "current_page": 123,
      "total_pages": 123,
      "total_records": 123,
      "has_next": true,
      "has_prev": true
    }
  }
}

Authorizations

anchor-api-key
string
header
required

API key passed in the header

Query Parameters

status
enum<string>

Filter batches by status

Available options:
pending,
processing,
completed,
failed,
cancelled
page
integer
default:1

Page number (1-based)

Required range: x >= 1
limit
integer
default:20

Number of results per page

Required range: 1 <= x <= 100
created_after
string<date-time>

Filter batches created after this timestamp (ISO 8601)

created_before
string<date-time>

Filter batches created before this timestamp (ISO 8601)

Response

Batch list retrieved successfully

data
object