Get Export List
get
/api/v1/bots/{botId}/insightExports
Returns a list of the skill bot's export tasks.
Request
Path Parameters
-
botId: string
The ID of the skill bot.
Query Parameters
-
limit(optional): integer(int64)
The number of items to return.
-
offset(optional): integer(int64)
The number of items to skip before starting to collect the result set, where
0is the first item. -
totalResults(optional): boolean
Whether to return the total number of items that match the request (excluding the paging parameters).
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Success.
Root Schema : InsightsExportPagingData
Type:
objectList of a skill's insights-export tasks.
Show Source
-
count(optional):
integer(int32)
The number of items returned.
-
hasMore(optional):
boolean
Indicates if there are more items to be returned.
-
items(optional):
array items
The items being returned.
-
limit(optional):
integer(int32)
The maximum number of items to return.
-
links(optional):
array links
-
offset(optional):
integer(int32)
The actual index from which the items are returned.
-
totalResults(optional):
integer(int32)
The total number of items.
Nested Schema : items
Type:
arrayThe items being returned.
Show Source
-
Array of:
object InsightsExport
The items being returned.
Nested Schema : InsightsExport
Type:
objectThe items being returned.
Show Source
-
beginDate:
string(date)
Pattern:
YYYY-MM-DDRange start date. -
createdByName(optional):
string
A name that identifies who created the export task.
-
endDate:
string(date)
Pattern:
YYYY-MM-DDRange end date. -
filters(optional):
object filters
Include only the data for the specified intent, channel, or locale or any combination of the three filters.
Nested Schema : filters
Type:
objectInclude 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(optional):
string(uri)
-
absolutePathBuilder(optional):
object absolutePathBuilder
-
baseUri(optional):
string(uri)
-
baseUriBuilder(optional):
object baseUriBuilder
-
matchedResources(optional):
array matchedResources
-
matchedURIs(optional):
array matchedURIs
-
path(optional):
string
-
pathParameters(optional):
object pathParameters
Additional Properties Allowed: additionalProperties
-
pathSegments(optional):
array pathSegments
-
queryParameters(optional):
object queryParameters
Additional Properties Allowed: additionalProperties
-
requestUri(optional):
string(uri)
-
requestUriBuilder(optional):
object requestUriBuilder
Nested Schema : Link
Type:
Show Source
object-
href(optional):
string
URL to the resource
-
rel(optional):
string
The relationship with the resource
Nested Schema : absolutePathBuilder
Type:
objectNested Schema : baseUriBuilder
Type:
objectNested Schema : requestUriBuilder
Type:
objectNested Schema : items
Type:
objectNested Schema : items
Type:
Show Source
object-
matrixParameters(optional):
object matrixParameters
Additional Properties Allowed: additionalProperties
-
path(optional):
string
404 Response
The skill doesn't exist or insights aren't enabled for the skill.