Main menu

Check the progress of an asynchronous import


If you specified async=1 in your original import API request, you can check on its progress with this endpoint.

The full URL including job identifier will have been provided in the Location header of your original import response

URI parameters


Job identifier from original import action

string required

API key - required if not sent in Authorization header

string optional

Request headers


API key sent as "Loco <key>" or "Basic <encoded>". See Authentication.

string required if not in query


A single JSON-encoded AsyncProgress object, which takes the following form:

    "progress": 0, // Percentage progress through asynchronous operation
    "success": "", // Message populated after successful completion
    "error": "", // Description of any error that prevented the operation from finishing

Try it

Open in test console »

« /api/import