Get Batch Status - Reach Marketing & Automation Documentation

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,
      "pendingRecords": 123,
      "failedRecords": 123,
      "successRate": 123
    },
    "completedAt": "<string>",
    "startedAt": "<string>",
    "createdAt": "<string>",
    "schemaName": "<string>",
    "schemaDefinitionId": "<string>",
    "errors": {
      "summary": {},
      "details": {},
      "message": "<string>"
    },
    "pendingResources": [
      {
        "id": "<string>",
        "resourceExternalId": "<string>",
        "schemaDefinitionId": "<string>",
        "missingDependencies": [
          {
            "schemaDefinitionId": "<string>",
            "externalId": "<string>",
            "schemaName": "<string>"
          }
        ],
        "expiresAt": "<string>",
        "createdAt": "<string>",
        "schemaName": "<string>"
      }
    ]
  }
}

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,
      "pendingRecords": 123,
      "failedRecords": 123,
      "successRate": 123
    },
    "completedAt": "<string>",
    "startedAt": "<string>",
    "createdAt": "<string>",
    "schemaName": "<string>",
    "schemaDefinitionId": "<string>",
    "errors": {
      "summary": {},
      "details": {},
      "message": "<string>"
    },
    "pendingResources": [
      {
        "id": "<string>",
        "resourceExternalId": "<string>",
        "schemaDefinitionId": "<string>",
        "missingDependencies": [
          {
            "schemaDefinitionId": "<string>",
            "externalId": "<string>",
            "schemaName": "<string>"
          }
        ],
        "expiresAt": "<string>",
        "createdAt": "<string>",
        "schemaName": "<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

Query Parameters

includePendingDetails

enum<string>

Whether to include detailed information about pending resources and their dependencies

Available options:

true,

false

Response

Status 200 response

success

boolean

required

message

string

data

object

Show child attributes

data.batchId

string

required

The ID of the batch operation

data.status

enum<string>

required

The current status of the batch operation

Available options:

success,

partial_success,

failure,

processing

data.batchType

enum<string>

required

The type of batch operation

Available options:

PARTNER_RESOURCE_JSON_INGEST,

PARTNER_RESOURCE_BATCH_DELETE,

PARTNER_RESOURCE_BATCH_PATCH

data.progress

object

required

Detailed progress information

Show child attributes

data.progress.totalRecords

number

Total number of records in the batch

data.progress.processedRecords

number

Number of records processed so far

data.progress.successfulRecords

number

Number of records processed successfully

data.progress.pendingRecords

number

Number of records stored as pending due to missing dependencies

data.progress.failedRecords

number

Number of records that failed processing

data.progress.successRate

number

Percentage of successful records (0-100)

data.completedAt

string

Timestamp when the batch completed processing

data.startedAt

string

Timestamp when the batch started processing

data.createdAt

string

Timestamp when the batch was created

data.schemaName

string

The name of the schema definition used for this batch

data.schemaDefinitionId

string

The ID of the schema definition used for this batch

data.errors

object

Error information if there were any issues

Show child attributes

data.errors.summary

object

Summary of error categories and counts

Show child attributes

data.errors.summary.{key}

number

data.errors.details

object

Detailed errors organized by record external ID

Show child attributes

data.errors.details.{key}

object

Show child attributes

data.errors.details.{key}.errors

string[]

required

data.errors.details.{key}.categories

string[]

required

data.errors.message

string

General error message if the entire batch failed

data.pendingResources

object[]

Detailed information about resources stored as pending (only included if includePendingDetails query parameter is set)

Show child attributes

data.pendingResources.id

string

required

The ID of the pending resource

data.pendingResources.resourceExternalId

string

required

The external ID of the resource that is pending

data.pendingResources.schemaDefinitionId

string

required

The schema definition ID for this resource

data.pendingResources.missingDependencies

object[]

required

List of dependencies this resource is waiting for

Show child attributes

data.pendingResources.missingDependencies.schemaDefinitionId

string

required

The schema definition ID of the missing dependency

data.pendingResources.missingDependencies.externalId

string

required

The external ID of the missing dependency

data.pendingResources.missingDependencies.schemaName

string

The schema definition name of the missing dependency

data.pendingResources.expiresAt

string

required

When this pending resource will expire if dependencies are not resolved

data.pendingResources.createdAt

string

required

When the resource was stored as pending

data.pendingResources.schemaName

string

The schema definition name for this resource

List Batch Jobs List Channel Accounts

⌘I

API Documentation

Headers

Path Parameters

Query Parameters

Response