Saltar al contenido principal
GET
/
v1
/
batches
/
{batch_id}
Obtener información del lote
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
}
Adjuntar datos personalizados: Usa el parámetro metadata para almacenar pares clave-valor con tu lote. Consulta Metadatos para más detalles.

Autorizaciones

​
Authorization
string
header
requerido

Encabezado de autenticación Bearer de la forma Bearer , donde es tu token de autenticación.

Parámetros de ruta

​
batch_id
string
requerido

El ID del lote para obtener información.

Respuesta

Respuesta exitosa con información del lote.

​
id
string

ID del Lote

​
object
string

El tipo de objeto. "batch" para este endpoint.

​
status
string

in_progress o completed

​
created
number

Época creada

​
total_urls
number

Conteo de URLs en el lote

​
completed_urls
number

Conteo de URLs completadas

​
parser
string
​
country
string
​
metadata
object

Conjunto de pares clave-valor para almacenar información adicional sobre un objeto. Sigue el enfoque de Stripe con reglas de validación: máximo 50 claves, clave máximo 40 caracteres (sin corchetes), valor máximo 500 caracteres, todos los valores almacenados como cadenas.

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

URL del webhook para recibir la notificación de finalización

​
credits_consumed
integer | null

Número de créditos consumidos por esta solicitud. Se completa después de que la ejecución finaliza. Los créditos son la fuente de verdad para la facturación.

​
cost_usd
number | null

Costo estimado en USD para esta solicitud. Se completa después de que la ejecución finaliza. Calculado a partir de los créditos consumidos y tu tarifa de plan — 99% preciso, pero credits_consumed es el valor autoritativo.