Get Export Task

get

/api/v1/bots/insightDataExport/{exportId}

Returns a description of the given instance-level export task.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Success.
Body ()
Root Schema : InsightsDataExportResponse
Type: object
The items being returned.
Show Source
  • Pattern: YYYY-MM-DD
    Range start date.
  • Read Only: true
    A name that identifies who created the export task.
  • Pattern: YYYY-MM-DD
    Range end date.
  • The name of the export job as specified in the create request.
  • Timestamp of when the job started.
  • The export task's id.
  • Allowed Values: [ "PURGE_SUCCEEDED", "PURGE_FAILED", "EXPORT_SUCCEEDED", "EXPORT_FAILED", "NO_DATA", "SUBMITTED", "IN_PROGRESS" ]
    The current status of the export.
    • SUBMITTED: The export was submitted.
    • IN_PROGRESS: The export is in progress.
    • PURGE_SUCCEEDED: The purge completed successfully.
    • PURGE_FAILED: The purge failed. The error property provides more information.
    • EXPORT_SUCCEEDED: The export completed successfully.
    • EXPORT_FAILED: The export failed. The error property provides more information.
    • NO_DATA: There wasn't any data to export or purge. Try a different date range or filter.

404 Response

The export task doesn't exist.
Back to Top