Upload

Get bulk import batch status

GET
/upload/imports/{batch_id}

Returns progress for a batch created via POST /upload/from-urls. Only the user who created the batch may view its status.

Authorization

token_auth
headerAuthorizationBearer <token>

Token-based authentication using access tokens.

Path Parameters

batch_id*string

Response Body

Successful Response

application/json
  1. response
batch_id*Batch Id

UUID of the import batch.

total*Total

Total number of items in the batch.

completed*Completed

Number of items successfully ingested so far.

failed*Failed

Number of items that failed ingestion so far.

finished*Finished

Number of items that have reached a terminal state (completed + failed).

status*Status

"processing" until every item has finished, then "completed".

items*array<>

Per-item progress detail, in submission order.

curl -X GET "https://example.com/upload/imports/string"
{  "batch_id": "string",  "total": 0,  "completed": 0,  "failed": 0,  "finished": 0,  "status": "string",  "items": [    {      "url": "string",      "source": "string",      "filename": "string",      "status": "string",      "asset_id": "string",      "error": "string"    }  ]}