Zum Hauptinhalt springen
GET
/
v1
/
batches
/
{batch_id}
Batch-Informationen abrufen
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
}
Benutzerdefinierte Daten anhängen: Verwende den metadata-Parameter, um Schlüssel-Wert-Paare mit deinem Batch zu speichern. Siehe Metadaten für Details.

Autorisierungen

​
Authorization
string
header
erforderlich

Bearer-Authentifizierungsheader in der Form Bearer , wobei dein Authentifizierungstoken ist.

Pfadparameter

​
batch_id
string
erforderlich

Die ID des Batches, für den Informationen abgerufen werden sollen.

Antwort

Erfolgreiche Antwort mit Batch-Informationen.

​
id
string

Charge-ID

​
object
string

Die Art des Objekts. "batch" für diesen Endpunkt.

​
status
string

in_progress oder completed

​
created
number

Erstellte Epoche

​
total_urls
number

Anzahl der URLs im Batch

​
completed_urls
number

Anzahl der abgeschlossenen URLs

​
parser
string
​
country
string
​
metadata
object

Satz von Schlüssel-Wert-Paaren zur Speicherung zusätzlicher Informationen über ein Objekt. Folgt dem Ansatz von Stripe mit Validierungsregeln: maximal 50 Schlüssel, Schlüssel maximal 40 Zeichen (keine eckigen Klammern), Wert maximal 500 Zeichen, alle Werte als Strings gespeichert.

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

Webhook-URL, um eine Benachrichtigung über den Abschluss zu erhalten

​
credits_consumed
integer | null

Anzahl der durch diese Anfrage verbrauchten Credits. Wird nach Abschluss der Ausführung ausgefüllt. Credits sind die Grundlage für die Abrechnung.

​
cost_usd
number | null

Geschätzte Kosten in USD für diese Anfrage. Wird nach Abschluss der Ausführung ausgefüllt. Berechnet aus den verbrauchten Credits und deinem Tarif — 99% genau, aber credits_consumed ist der maßgebliche Wert.