Skip to main content
GET
/
v1
/
batches
/
{batch_id}
Retrieve batch information
curl --request GET \
  --url https://api.olostep.com/v1/batches/{batch_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "object": "<string>",
  "status": "<string>",
  "created": 123,
  "total_urls": 123,
  "completed_urls": 123,
  "parser": "<string>",
  "country": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
batch_id
string
required

The ID of the batch to retrieve information for.

Response

Successful response with batch information.

​
id
string

Batch ID

​
object
string

The kind of object. "batch" for this endpoint.

​
status
string

in_progress or completed

​
created
number

Created epoch

​
total_urls
number

Count of URLs in the batch

​
completed_urls
number

Count of completed URLs

​
parser
string
​
country
string
⌘I