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>",
  "credits_consumed": 123,
  "cost_usd": 123
}
Aangepaste gegevens toevoegen: 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 , waar 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 endpoint.

status
string

in_progress of completed

created
number

Aangemaakte 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 Stripe's aanpak met validatieregels: max 50 sleutels, sleutel max 40 tekens (geen vierkante haken), waarde max 500 tekens, alle waarden opgeslagen als strings.

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

Webhook URL om een voltooiingsmelding te ontvangen

credits_consumed
integer | null

Aantal credits verbruikt door dit verzoek. Wordt ingevuld nadat de uitvoering voltooid is. Credits zijn de bron van waarheid voor facturering.

cost_usd
number | null

Geschatte kosten in USD voor dit verzoek. Wordt ingevuld nadat de uitvoering voltooid is. Berekend op basis van verbruikte credits en je abonnementsprijs — 99% nauwkeurig, maar credits_consumed is de gezaghebbende waarde.