Jump to

• Request
• Response

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

• botId(required): string
  Filters by botId.
• limit(required): integer(int32)
• offset(required): integer(int32)
• order(required): string
  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.
• statusFilter(required): string
  Filters by status. Possible values: SUCCESS, FAILED, SUBMITTED, IN_PROGRESS, PURGE_SUCCEEDED, PURGE_FAILED, EXPORT_SUCCEEDED, EXPORT_FAILED, NO_DATA.
• taskType(required): string
  Filters by task type. Possible values: EXPORT, SKILL_EXPORT, EXPORT_PURGE,
• totalResults: boolean
  Whether to return the total number of items that match the request (excluding the paging parameters).

  Default Value: false
• userFilter(required): string
  Filters by username

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success.

Body ()

Root Schema : ManagementApiExportJobDetails

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "filenames":{
            "type":"array",
            "description":"A list of the files holding the exported data.",
            "items":{
                "type":"string",
                "description":"A list of the files holding the exported data."
            }
        },
        "name":{
            "type":"string",
            "description":"The name that was provided when the task was created. If a name wasn't provided then it's a generated name."
        },
        "createdBy":{
            "type":"string",
            "description":"The user who created the task."
        },
        "beginDate":{
            "type":"string",
            "description":"Begin date of the data included in the task. Format: <code>dd-mm-yyyy</code>.",
            "format":"date-time"
        },
        "endDate":{
            "type":"string",
            "description":"End date of the data included in the task. Format: <code>dd-mm-yyyy</code>.",
            "format":"date-time"
        },
        "jobType":{
            "type":"string",
            "description":"The type of Task.<ul><li><code>EXPORT</code>: A task to export the data.</li><li><code>EXPORT_PURGE</code>: A task to both export and purge data.</li></ul>",
            "enum":[
                "EXPORT",
                "EXPORT_PURGE"
            ]
        },
        "jobId":{
            "type":"string",
            "description":"The unique ID of the task."
        },
        "status":{
            "type":"string",
            "description":"The status of the task.<ul><li><code>SUBMITTED</code>: The task was submitted.</li><li><code>IN_PROGRESS</code>: The task was is running, but has not completed yet.</li><li><code>PURGE_SUCCEEDED</code>: The export and purge were successful.</li><li><code>PURGE_FAILED</code>: The purge failed.  Since purge only runs after export, this means the export succeeded.</li><li><code>EXPORT_SUCCEEDED</code>: The export completed successfully.</li><li><code>EXPORT_FAILED</code>: The export failed.</li><li><code>SUCCESS</code>: This is the status for a successful delete.</li><li><code>FAILED</code>: The task failed due to an unexpected error.</li><li><code>NO_DATA</code>: There was no data to export. This can occur if  the filters that you specified for an export resulted in no data being  returned.</li></ul>",
            "enum":[
                "SUCCESS",
                "FAILED",
                "SUBMITTED",
                "IN_PROGRESS",
                "PURGE_SUCCEEDED",
                "PURGE_FAILED",
                "EXPORT_SUCCEEDED",
                "EXPORT_FAILED",
                "NO_DATA"
            ]
        },
        "error":{
            "type":"string",
            "description":"The error message."
        },
        "jobTimestamp":{
            "type":"string",
            "description":"The time the task started."
        }
    }
}

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.

{
    "type":"array",
    "description":"A list of the files holding the exported data.",
    "items":{
        "type":"string",
        "description":"A list of the files holding the exported data."
    }
}

Back to Top