Naar hoofdinhoud gaan
GET
/
v1
/
batches
/
{batch_id}
Batchinformatie ophalen
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>",
  "metadata": {
    "order_id": "12345",
    "customer_name": "John Doe",
    "priority": "high",
    "processed": "true"
  },
  "webhook": "<string>"
}

Documentation Index

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

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

Voeg aangepaste gegevens toe: Gebruik de metadata parameter om sleutel-waardeparen met je batch op te slaan. Zie Metadata voor details.

Autorisaties

​
Authorization
string
header
vereist

Bearer authenticatie header in de vorm Bearer , waarbij jouw auth token is.

Padparameters

​
batch_id
string
vereist

De ID van de batch waarvoor je informatie wilt ophalen.

Respons

Succesvolle reactie met batchinformatie.

​
id
string

Batch ID

​
object
string

Het soort object. "batch" voor dit eindpunt.

​
status
string

in_progress of completed

​
created
number

Gemaakt epoch

​
total_urls
number

Aantal URLs in de batch

​
completed_urls
number

Aantal voltooide URLs

​
parser
string
​
country
string
​
metadata
object

Set van sleutel-waarde paren voor het opslaan van aanvullende informatie over een object. Volgt de aanpak van Stripe met validatieregels: maximaal 50 sleutels, sleutel maximaal 40 tekens (geen vierkante haken), waarde maximaal 500 tekens, alle waarden opgeslagen als strings.

Voorbeeld:
{
  "order_id": "12345",
  "customer_name": "John Doe",
  "priority": "high",
  "processed": "true"
}
​
webhook
string

Webhook URL om voltooiingsmelding te ontvangen