Jump to

• Request
• Response

Get Export Task Status

get

/api/v1/bots/{botId}/insightExports/{exportId}/status

Returns the status of a skill-level export task.

Request

Path Parameters

• botId(required): string
  The ID of the skill bot.
• exportId(required): string
  Export task's ID.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success.

Body ()

Root Schema : InsightsExportStatusResponse

Type: object

Show Source

• error: string
  If the export task failed, then this property explains why it failed. Otherwise, it contains 'No Error'
• status: string
  Allowed Values: [ "Completed", "In_Progress", "Failed", "Started", "No_Data" ]

  The current status of the export.

  • Completed: The export completed successfully
  • In_Progress: The export is in progress.
  • Failed: The export failed.
  • Started: The export has started.
  • No_Data: There wasn't any data to export. Try a different date range or filter.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"The current status of the export.<ul><li><code>Completed</code>: The export completed successfully</li><li><code>In_Progress</code>: The export is in progress.</li><li><code>Failed</code>: The export failed.</li><li><code>Started</code>: The export has started.</li><li><code>No_Data</code>: There wasn't any data to export.  Try a different date range or filter.</li></ul>",
            "enum":[
                "Completed",
                "In_Progress",
                "Failed",
                "Started",
                "No_Data"
            ]
        },
        "error":{
            "type":"string",
            "description":"If the export task failed, then this property explains why it failed. Otherwise, it contains 'No Error'"
        }
    }
}

404 Response

The export task doesn't exist.

Back to Top