Vai al contenuto principale
GET
/
v1
/
batches
/
{batch_id}
Recupera informazioni sul batch
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>"
}
Allega dati personalizzati: Usa il parametro metadata per memorizzare coppie chiave-valore con il tuo batch. Vedi Metadati per i dettagli.

Autorizzazioni

Authorization
string
header
obbligatorio

Intestazione di autenticazione Bearer della forma Bearer , dove è il tuo token di autenticazione.

Parametri del percorso

batch_id
string
obbligatorio

L'ID del batch per cui recuperare le informazioni.

Risposta

Risposta riuscita con informazioni sul batch.

id
string

ID del Batch

object
string

Il tipo di oggetto. "batch" per questo endpoint.

status
string

in_progress o completed

created
number

Epoch creato

total_urls
number

Conteggio degli URL nel batch

completed_urls
number

Conteggio degli URL completati

parser
string
country
string
metadata
object

Insieme di coppie chiave-valore per memorizzare informazioni aggiuntive su un oggetto. Segue l'approccio di Stripe con regole di validazione: massimo 50 chiavi, chiave massimo 40 caratteri (senza parentesi quadre), valore massimo 500 caratteri, tutti i valori memorizzati come stringhe.

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

URL del webhook per ricevere la notifica di completamento