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
- application/json
A description of the data to export.
Root Schema : schema
Type:
Show Source
object
-
beginDate(required): string
(date)
Pattern:
YYYY-MM-DD
Range start date. -
createdByName(required): string
A name that identifies who created the export task.
-
endDate(required): string
(date)
Pattern:
YYYY-MM-DD
Range end date. -
name: string
Name for the export task. The name must begin with a letter and it can contain only letters, numbers, and underscores.Example:
FebInstanceExport
-
type(required): string
Allowed Values:
[ "EXPORT", "EXPORT_AND_PURGE" ]
UseEXPORT
to export and retain the data and useEXPORT_AND_PURGE
to export the data and then delete it.
Response
Supported Media Types
- application/json
200 Response
Success.
Root Schema : InsightsExportTaskResponse
Type:
Show Source
object
-
jobName: string
The name of the export job as specified in the create request.
-
resourceId: string
The export task's ID.