Get Batch Enrichment Status

Request

Check the current processing status of a batch enrichment job.

What you get

Current state (e.g., queued/running/completed/failed)
Progress indicators (processed vs remaining), when available

Credits

0 credits (status only)

Security

Bearer

Path

batch_idstringrequired

Unique batch identifier returned when creating the enrichment batch

GET

/public/v1/enrichment/batch/{batch_id}/status/

curl -i -X GET \
  'https://api-dashboard.influencers.club/public/v1/enrichment/batch/{batch_id}/status/' \
  -H 'Authorization: Bearer <YOUR_API_KEY_HERE>'

Responses

Bodyapplication/json

batch_idstringrequired

Unique identifier for the batch enrichment job

statusstringrequired

Current status of the batch job (processing, finished, failed, queued, paused_insufficient_credits)

total_rowsintegerrequired

Total number of records submitted in the batch

processed_rowsintegerrequired

Total number of records that have finished processing

success_countintegerrequired

Number of records processed successfully

failed_countintegerrequired

Number of records that failed or could not be processed

started_atstring, (date-time)required

Timestamp when the batch was created

metadataobjectrequired

Metadata provided with the batch

credits_usedstring, (decimal)^-?\d{0,8}(?:\.\d{0,2})?$required

Total number of credits used in the batch

estimated_completionstring or null, (date-time)

Estimated completion timestamp based on current progress (null if unavailable)

status_messagestring or null

Human-readable message about the batch status (only present when paused)

Response

{
  "batch_id": "string",
  "status": "string",
  "total_rows": 0,
  "processed_rows": 0,
  "success_count": 0,
  "failed_count": 0,
  "started_at": "2019-08-24T14:15:22Z",
  "metadata": {
    "property1": null,
    "property2": null
  },
  "credits_used": "string",
  "estimated_completion": "2019-08-24T14:15:22Z",
  "status_message": "string"
}