Get Export Task Status
get
/api/v1/bots/insights/dataExports/{id}
Returns the status and description of the insights export task that has the given job ID.
Request
Path Parameters
-
id(required): string
The job ID of the task to get the status for.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Success.
Root Schema : ManagementApiExportJobDetails
Type:
Show Source
object
-
beginDate: string
(date-time)
Begin date of the data included in the task. Format:
dd-mm-yyyy
. -
createdBy: string
The user who created the task.
-
endDate: string
(date-time)
End date of the data included in the task. Format:
dd-mm-yyyy
. -
error: string
The error message.
-
filenames: array
filenames
A list of the files holding the exported data.
-
jobId: string
The unique ID of the task.
-
jobTimestamp: string
The time the task started.
-
jobType: string
Allowed Values:
[ "EXPORT", "EXPORT_PURGE" ]
The type of Task.EXPORT
: A task to export the data.EXPORT_PURGE
: A task to both export and purge data.
-
name: string
The name that was provided when the task was created. If a name wasn't provided then it's a generated name.
-
status: string
Allowed Values:
[ "SUCCESS", "FAILED", "SUBMITTED", "IN_PROGRESS", "PURGE_SUCCEEDED", "PURGE_FAILED", "EXPORT_SUCCEEDED", "EXPORT_FAILED", "NO_DATA" ]
The status of the task.SUBMITTED
: The task was submitted.IN_PROGRESS
: The task was is running, but has not completed yet.PURGE_SUCCEEDED
: The export and purge were successful.PURGE_FAILED
: The purge failed. Since purge only runs after export, this means the export succeeded.EXPORT_SUCCEEDED
: The export completed successfully.EXPORT_FAILED
: The export failed.SUCCESS
: This is the status for a successful delete.FAILED
: The task failed due to an unexpected error.NO_DATA
: There was no data to export. This can occur if the filters that you specified for an export resulted in no data being returned.
Nested Schema : filenames
Type:
array
A list of the files holding the exported data.
Show Source
-
Array of:
string
A list of the files holding the exported data.
404 Response
A task with the given job ID doesn't exist.