ListIntentPaths
Retrieves summary statistics for a path of intents that users take over sessions with your bot. The following fields are required:
-
startDateTimeandendDateTime– Define a time range for which you want to retrieve results. -
intentPath– Define an order of intents for which you want to retrieve metrics. Separate intents in the path with a forward slash. For example, populate theintentPathfield with/BookCar/BookHotelto see details about how many times users invoked theBookCarandBookHotelintents in that order.
Use the optional filters field to filter the results.
Request Syntax
POST /bots/botId/analytics/intentpaths HTTP/1.1
Content-type: application/json
{
"endDateTime": number,
"filters": [
{
"name": "string",
"operator": "string",
"values": [ "string" ]
}
],
"intentPath": "string",
"startDateTime": number
}URI Request Parameters
The request uses the following URI parameters.
- botId
-
The identifier for the bot for which you want to retrieve intent path metrics.
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$Required: Yes
Request Body
The request accepts the following data in JSON format.
- endDateTime
-
The date and time that marks the end of the range of time for which you want to see intent path metrics.
Type: Timestamp
Required: Yes
- filters
-
A list of objects, each describes a condition by which you want to filter the results.
Type: Array of AnalyticsPathFilter objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: No
- intentPath
-
The intent path for which you want to retrieve metrics. Use a forward slash to separate intents in the path. For example:
-
/BookCar
-
/BookCar/BookHotel
-
/BookHotel/BookCar
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
-
- startDateTime
-
The date and time that marks the beginning of the range of time for which you want to see intent path metrics.
Type: Timestamp
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nodeSummaries": [
{
"intentCount": number,
"intentLevel": number,
"intentName": "string",
"intentPath": "string",
"nodeType": "string"
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- nodeSummaries
-
A list of objects, each of which contains information about a node in the intent path for which you requested metrics.
Type: Array of AnalyticsIntentNodeSummary objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerException
-
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
- PreconditionFailedException
-
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
- ServiceQuotaExceededException
-
You have reached a quota for your bot.
HTTP Status Code: 402
- ThrottlingException
-
Your request rate is too high. Reduce the frequency of requests.
HTTP Status Code: 429
- ValidationException
-
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
