Start Export Task

post

/api/v1/bots/insightDataExport

Creates and starts an asynchronous job to export the instance's insights data into a ZIP of CSV files. You can filter the data to export by name, a date range, or both. The response includes a resourceId value, which you can use for the exportId when you call GET /bots/insightDataExport/{exportId}/data to download the exported data.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
A description of the data to export.
Root Schema : schema
Type: object
Show Source
  • Pattern: YYYY-MM-DD
    Range start date.
  • A name that identifies who created the export task.
  • Pattern: YYYY-MM-DD
    Range end date.
  • Name for the export task. The name must begin with a letter and it can contain only letters, numbers, and underscores.
    Example: FebInstanceExport
  • Allowed Values: [ "EXPORT", "EXPORT_AND_PURGE" ]
    Use EXPORT to export and retain the data and use EXPORT_AND_PURGE to export the data and then delete it.
Back to Top

Response

Supported Media Types

200 Response

Success.
Body ()
Root Schema : InsightsExportTaskResponse
Type: object
Show Source
Back to Top