Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListUtteranceAnalyticsData

Note

To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics. See Viewing utterance statistics for the IAM policy to apply to the IAM role.

Retrieves a list of metadata for individual user utterances to your bot. The following fields are required:

startDateTime and endDateTime – Define a time range for which you want to retrieve results.

Of the optional fields, you can organize the results in the following ways:

Use the filters field to filter the results and the sortBy field to specify the values by which to sort the results.
Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.

Request Syntax


POST /bots/botId/analytics/utterances HTTP/1.1
Content-type: application/json

{
   "endDateTime": number,
   "filters": [ 
      { 
         "name": "string",
         "operator": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string",
   "sortBy": { 
      "name": "string",
      "order": "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 utterance analytics.

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 utterance analytics.

Type: Timestamp

Required: Yes

filters

A list of objects, each of which describes a condition by which you want to filter the results.

Type: Array of AnalyticsUtteranceFilter objects

Array Members: Minimum number of 1 item. Maximum number of 9 items.

Required: No

maxResults

The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

nextToken

If the response from the ListUtteranceAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.

Use the returned token in the nextToken parameter of a ListUtteranceAnalyticsData request to return the next page of results. For a complete set of results, call the ListUtteranceAnalyticsData operation until the nextToken returned in the response is null.

Type: String

Required: No

sortBy

An object specifying the measure and method by which to sort the utterance analytics data.

Type: UtteranceDataSortBy object

Required: No

startDateTime

The date and time that marks the beginning of the range of time for which you want to see utterance analytics.

Type: Timestamp

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "botId": "string",
   "nextToken": "string",
   "utterances": [ 
      { 
         "associatedIntentName": "string",
         "associatedSlotName": "string",
         "audioVoiceDurationMillis": number,
         "botAliasId": "string",
         "botResponseAudioVoiceId": "string",
         "botResponses": [ 
            { 
               "content": "string",
               "contentType": "string",
               "imageResponseCard": { 
                  "buttons": [ 
                     { 
                        "text": "string",
                        "value": "string"
                     }
                  ],
                  "imageUrl": "string",
                  "subtitle": "string",
                  "title": "string"
               }
            }
         ],
         "botVersion": "string",
         "channel": "string",
         "conversationEndTime": number,
         "conversationStartTime": number,
         "dialogActionType": "string",
         "inputType": "string",
         "intentState": "string",
         "localeId": "string",
         "mode": "string",
         "outputType": "string",
         "sessionId": "string",
         "slotsFilledInSession": "string",
         "utterance": "string",
         "utteranceRequestId": "string",
         "utteranceTimestamp": number,
         "utteranceUnderstood": boolean
      }
   ]
}

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.

botId

The unique identifier of the bot that the utterances belong to.

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

nextToken

If the response from the ListUtteranceAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.

Type: String

utterances

A list of objects, each of which contains information about an utterance in a user session with your bot.

Type: Array of UtteranceSpecification objects

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