Skip to main content

Get the status of An Export Data Job​


To get the status of an export data job, include the id as a query parameter in the request. You can view the schema and an example in the sections below or find full documentation under API Reference in the sidebar.

Request Example​

GET /tp-api/exports?id=your-job-id-here HTTP/1.1
Host: yourdomain.com

Response Structure​

The api response includes two main objects:

  • job:

    • id: The unique ID of the export request (Base64-encoded).
    • status: The current status of the job, which can be "COMPLETED", "PENDING", or "FAILED".
    • downloadUrl: The URL to download the exported data (if available).
    • downloadExpiresAt: The expiry time of the file (in ISO 8601 format).

  • errors:

    • key: A key identifying the error (if any).
    • message: A detailed error message.
Response Example

      {
        "job": {
          "id": "WyJkYXRhLWV4cG9ydHx0ZW5hbnRLZXk6ZHJlYW1idWlsZGVyfHR5cGU6bGVhcm5pbmdfYWN0aXZpdGllc3xmb3JtYXQ6anNvbmx8c3RhcnQ6MjAxMi0wOS0wNVQxMToxMjo0Ny4wMDBafGVuZDoyMDE1LTA1LTI4VDE3OjM5OjIzLjAwMFoiLCJiYjNiNzIyOS0xYTJhLTQzYzgtYmM4Mi01MTc4MjIzMGI4NDYiXQ==",
          "status": "COMPLETED",
          "exportData": {
            "downloadUrl": "https://www.example.com",
            "downloadExpiresAt": "2024-09-26T16:49:35.471Z"
          },
        },
        "errors": []
      }

This guide explains how to get the status of an export data job. Use the returned id to track the export job, and check the status field to monitor its progress. If the status is COMPLETED then use the downloadUrl in the response to download the csv/json file. For more details, consult the full API documentation.