List Export Tasks

get

/api/v1/bots/insights/dataExports

Returns a list of insights export tasks along with the status for each task.

Request

Query Parameters
  • Filters by botId.
  • The order in which to sort the results. There are two parts to this query parameter: orderField-direction where orderField is the field to sort on and can be one of:
    • CREATEDBY: Sort on the name of the user that created the export
    • STATUS: Sort by export status.
    • LASTRUN: Sort on the timestamp of the export
    • NAME: Sort by export name
    The direction can be either ASC (for ascending) or DESC (for descending). For instance, LASTRUN-DESC sorts by the timestamp of the export in a descending manner.
  • Filters by status. Possible values: SUCCESS, FAILED, SUBMITTED, IN_PROGRESS, PURGE_SUCCEEDED, PURGE_FAILED, EXPORT_SUCCEEDED, EXPORT_FAILED, NO_DATA.
  • Filters by task type. Possible values: EXPORT, SKILL_EXPORT, EXPORT_PURGE,
  • Whether to return the total number of items that match the request (excluding the paging parameters).
  • Filters by username

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Success.
Body ()
Root Schema : ManagementApiExportJobDetails
Type: object
Show Source
  • Begin date of the data included in the task. Format: dd-mm-yyyy.
  • The user who created the task.
  • End date of the data included in the task. Format: dd-mm-yyyy.
  • The error message.
  • filenames
    A list of the files holding the exported data.
  • The unique ID of the task.
  • The time the task started.
  • 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.
  • The name that was provided when the task was created. If a name wasn't provided then it's a generated name.
  • 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
Back to Top