Get Export List
get
/api/v1/bots/{botId}/insightExports
Returns a list of the skill bot's export tasks.
Request
Path Parameters
-
botId(required): string
The ID of the skill bot.
Query Parameters
-
limit: integer(int64)
The number of items to return.Default Value:
100
-
offset: integer(int64)
The number of items to skip before starting to collect the result set, where
0
is the first item.Default Value:0
-
totalResults: boolean
Whether to return the total number of items that match the request (excluding the paging parameters).Default Value:
false
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Success.
Root Schema : InsightsExportPagingData
Type:
object
List of a skill's insights-export tasks.
Show Source
-
count: integer
(int32)
The number of items returned.
-
hasMore: boolean
Indicates if there are more items to be returned.
-
items: array
items
The items being returned.
-
limit: integer
(int32)
The maximum number of items to return.
-
links: array
links
-
offset: integer
(int32)
The actual index from which the items are returned.
-
totalResults: integer
(int32)
The total number of items.
Nested Schema : items
Type:
array
The items being returned.
Show Source
-
Array of:
object InsightsExport
The items being returned.
Nested Schema : InsightsExport
Type:
object
The items being returned.
Show Source
-
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.
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"
}
}
}
}
}
}
Nested Schema : selfLinks
Type:
Show Source
object
-
absolutePath: string
(uri)
-
absolutePathBuilder: object
absolutePathBuilder
-
baseUri: string
(uri)
-
baseUriBuilder: object
baseUriBuilder
-
matchedResources: array
matchedResources
-
matchedURIs: array
matchedURIs
-
path: string
-
pathParameters: object
pathParameters
Additional Properties Allowed: additionalProperties
-
pathSegments: array
pathSegments
-
queryParameters: object
queryParameters
Additional Properties Allowed: additionalProperties
-
requestUri: string
(uri)
-
requestUriBuilder: object
requestUriBuilder
Nested Schema : Link
Type:
Show Source
object
-
href: string
URL to the resource
-
rel: string
The relationship with the resource
Nested Schema : absolutePathBuilder
Type:
object
Nested Schema : baseUriBuilder
Type:
object
Nested Schema : requestUriBuilder
Type:
object
Nested Schema : items
Type:
object
Nested Schema : items
Type:
Show Source
object
-
matrixParameters: object
matrixParameters
Additional Properties Allowed: additionalProperties
-
path: string
404 Response
The skill doesn't exist or insights aren't enabled for the skill.