Track import progress

Reports how far a started import has got. Use it to monitor an import after starting it — typically by polling until every record has been processed.

The import is finished when the processed count equals the total count. The error count tells you how many records were rejected along the way; use the errors endpoint to see why.

get

/migrations/{migration_id}/progress/

Authorizations

AuthorizationstringRequired

Token credential sent in the Authorization header, in the form: Token <your-token>. Requires a staff (admin) account.

Path parameters

migration_idstringRequired

Identifier returned when the import was started.

Example: 3f2a1c9e8b7d4a6f9c0e1d2b3a4c5e6f

Responses

200

Current progress of the import.

application/json

total_countintegerOptional

Total number of records to import.

Example: 1500

processed_countintegerOptional

Number of records processed so far (imported or rejected).

Example: 1500

error_countintegerOptional

Number of records rejected so far.

Example: 12

401

Authentication credentials were missing or invalid.

403

The account does not have staff (admin) permission.

406

No import is in progress for the given identifier.

application/json

get/migrations/{migration_id}/progress/

GET /api/remote/1/migrations/{migration_id}/progress/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "total_count": 1500,
  "processed_count": 1500,
  "error_count": 12
}