Get Export Task
get
/api/v1/bots/insightDataExport/{exportId}
Returns a description of the given instance-level export task.
Request
Path Parameters
-
exportId(required): string
The export task's ID.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Success.
Root Schema : InsightsDataExportResponse
Type:
object
The items being returned.
Show Source
-
beginDate: string
(date)
Pattern:
YYYY-MM-DD
Range start date. -
createdByName(required): string
Read Only:
true
A name that identifies who created the export task. -
endDate: string
(date)
Pattern:
YYYY-MM-DD
Range end date. -
jobName: string
The name of the export job as specified in the create request.
-
jobTimestamp: string
(date)
Timestamp of when the job started.
-
resourceId: string
The export task's id.
-
status: string
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. Theerror
property provides more information.EXPORT_SUCCEEDED
: The export completed successfully.EXPORT_FAILED
: The export failed. Theerror
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.