Start Export Task
post
/api/v1/bots/{botId}/insightExports
Creates and starts an asynchronous job to export the skill's insights data into a CSV file. You can filter the data to export by name, a date range, or both. The response includes a
resourceId
value, which you use for the exportId
. After you start the task, use the Get Export Task Status operation to monitor the job status. After the status changes to Completed
, you can call the Get Exported Data operation.Request
Path Parameters
-
botId(required): string
The ID of the skill bot.
Supported Media Types
- application/json
Description of what data to export.
Root Schema : schema
Type:
Show Source
object
-
beginDate(required): string
(date)
Pattern:
YYYY-MM-DD
Range start date. -
createdByName: string
A name that identifies who created the export task.
-
endDate(required): string
(date)
Pattern:
YYYY-MM-DD
Range end date. -
filters: object
filters
Include only the data for the specified intent, channel, or locale or any combination of the three filters.
-
name: string
Name for the export task. The name must begin with a letter and it can contain only letters, numbers, and underscores.Example:
FebPizzaBotExport
Nested Schema : filters
Type:
object
Include only the data for the specified intent, channel, or locale or any combination of the three filters.
Example:
{
"filter":{
"meta":"",
"enclose1":{
"meta":"",
"enclose2":{
"meta":"",
"profileString":{
"column":"INTENT",
"test":{
"op":"matches one of",
"arg":"Balances;Accounts"
}
}
}
},
"bool3":{
"content":"and"
},
"enclose4":{
"meta":"",
"enclose5":{
"meta":"",
"profileString":{
"column":"CHANNEL",
"test":{
"op":"matches one of",
"arg":"test; facebook"
}
}
}
},
"bool6":{
"content":"and"
},
"enclose7":{
"meta":"",
"enclose8":{
"meta":"",
"profileString":{
"column":"BR_LANG",
"test":{
"op":"matches one of",
"arg":"en-US; en-UK"
}
}
}
}
}
}
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.
404 Response
The skill doesn't exist or insights aren't enabled for the skill.