GET
/
api
/
batches
/
{batchId}
Get Batch Status
curl --request GET \
  --url https://api.embedreach.com/api/batches/{batchId}
{
  "success": true,
  "message": "<string>",
  "data": {
    "batchId": "<string>",
    "status": "success",
    "batchType": "PARTNER_RESOURCE_JSON_INGEST",
    "progress": {
      "totalRecords": 123,
      "processedRecords": 123,
      "successfulRecords": 123,
      "failedRecords": 123,
      "successRate": 123
    },
    "completedAt": "<string>",
    "errors": {
      "summary": {},
      "details": {},
      "message": "<string>"
    }
  }
}

Headers

reach-tenant-id
string

If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.

Path Parameters

batchId
string
required

The batch ID to check status for

Response

200
application/json

Status 200 response

The response is of type object.