Skip to main content

List batch statistics

Request​

GET /batches?[start=<start-date>][&end=<end-date>][&skipTo=<batchId>]

Parameters​

NameTypeInDescription
startdatequeryOptional. The start date and time for the search range. Default is 30 days back.
enddatequeryOptional. The end date and time for the search range. Default is the current day.
skipTostringqueryOptional. The batch id to continue from. Do not use this value directly, use the value of the Link response header.
pageSizeintqueryOptional Maximum number of items to retrieve. Range: between 1 and 100.

Response example​

Body​

{
"batches": [
{
"id": "xxx",
"pointerId": "yyy",
"passed": 76,
"failed": 9,
"unresolved": 6,
"new": 38,
"aborted": 1,
"empty": 2,
"total": 132,
"status": "Passed"
}, ...
]
}

Special headers​

NameDescription
LinkFormat (if present): <https://eyes.applitools.com/api/v1/batches?start=2022-01-06Z&end=2022-02-06&skipTo=02517910649999999999>; rel="next"

cURL example​

curl -H "X-Eyes-Api-Key: <your-api-key>" -X GET "https://eyes.applitools.com/api/v1/batches"