Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14107861793.8 KB

Provides a list of utterances that users have sent to the bot.

Utterances are aggregated by the text of the utterance. For example, all instances where customers used the phrase "I want to order pizza" are aggregated into the same line in the response.

You can see both detected utterances and missed utterances. A detected utterance is where the bot properly recognized the utterance and activated the associated intent. A missed utterance was not recognized by the bot and didn't activate an intent.

Utterances can be aggregated for a bot alias or for a bot version, but not both at the same time.

Utterances statistics are not generated under the following conditions:

  • The childDirected field was set to true when the bot was created.

  • You are using slot obfuscation with one or more slots.

  • You opted out of participating in improving Amazon Lex.

post/bots/{botId}/aggregatedutterances/

Path parameters

botIdstring required

The unique identifier of the bot associated with this request.

Request body

botAliasIdstring

The identifier of the bot alias associated with this request. If you specify the bot alias, you can't specify the bot version.

botVersionstring

The identifier of the bot version associated with this request. If you specify the bot version, you can't specify the bot alias.

localeIdstring required

The identifier of the language and locale where the utterances were collected. For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.

maxResultsinteger

The maximum number of utterances 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. If you don't specify the <code>maxResults</code> parameter, 1,000 results are returned.

nextTokenstring

If the response from the <code>ListAggregatedUtterances</code> operation contains more results that specified in the <code>maxResults</code> parameter, a token is returned in the response. Use that token in the <code>nextToken</code> parameter to return the next page of results.

Response

Success

botIdstring

The identifier of the bot that contains the utterances.

botAliasIdstring

The identifier of the bot alias that contains the utterances. If you specified the bot version, the bot alias ID isn't returned.

botVersionstring

The identifier of the bot version that contains the utterances. If you specified the bot alias, the bot version isn't returned.

localeIdstring

The identifier of the language and locale that the utterances are in.

aggregationWindowStartTimestring date-time

The date and time that the aggregation window begins. Only data collected after this time is returned in the results.

aggregationWindowEndTimestring date-time

The date and time that the aggregation window ends. Only data collected between the start time and the end time are returned in the results.

aggregationLastRefreshedDateTimestring date-time
<p>The last date and time that the aggregated data was collected. The time period depends on the length of the aggregation window.</p> <ul> <li> <p> <b>Hours</b> - for 1 hour time window, every half hour; otherwise every hour.</p> </li> <li> <p> <b>Days</b> - every 6 hours</p> </li> <li> <p> <b>Weeks</b> - for a one week time window, every 12 hours; otherwise, every day</p> </li> </ul>
nextTokenstring

A token that indicates whether there are more results to return in a response to the <code>ListAggregatedUtterances</code> operation. If the <code>nextToken</code> field is present, you send the contents as the <code>nextToken</code> parameter of a <code>ListAggregatedUtterances</code> operation request to get the next page of results.