Skip to content

List Utterance Analytics Data

lexmodelsv2_list_utterance_analytics_data R Documentation

Description

To use this API operation, your IAM role must have permissions to perform the list_aggregated_utterances 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.

Usage

lexmodelsv2_list_utterance_analytics_data(botId, startDateTime,
  endDateTime, sortBy, filters, maxResults, nextToken)

Arguments

botId

[required] The identifier for the bot for which you want to retrieve utterance analytics.

startDateTime

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

endDateTime

[required] The date and time that marks the end of the range of time for which you want to see utterance analytics.

sortBy

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

filters

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

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.

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.

Value

A list with the following syntax: 

list(
  botId = "string",
  nextToken = "string",
  utterances = list(
    list(
      botAliasId = "string",
      botVersion = "string",
      localeId = "string",
      sessionId = "string",
      channel = "string",
      mode = "Speech"|"Text"|"DTMF"|"MultiMode",
      conversationStartTime = as.POSIXct(
        "2015-01-01"
      ),
      conversationEndTime = as.POSIXct(
        "2015-01-01"
      ),
      utterance = "string",
      utteranceTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      audioVoiceDurationMillis = 123,
      utteranceUnderstood = TRUE|FALSE,
      inputType = "string",
      outputType = "string",
      associatedIntentName = "string",
      associatedSlotName = "string",
      intentState = "Failed"|"Fulfilled"|"InProgress"|"ReadyForFulfillment"|"Waiting"|"FulfillmentInProgress",
      dialogActionType = "string",
      botResponseAudioVoiceId = "string",
      slotsFilledInSession = "string",
      utteranceRequestId = "string",
      botResponses = list(
        list(
          content = "string",
          contentType = "PlainText"|"CustomPayload"|"SSML"|"ImageResponseCard",
          imageResponseCard = list(
            title = "string",
            subtitle = "string",
            imageUrl = "string",
            buttons = list(
              list(
                text = "string",
                value = "string"
              )
            )
          )
        )
      )
    )
  )
)

Request syntax

svc$list_utterance_analytics_data(
  botId = "string",
  startDateTime = as.POSIXct(
    "2015-01-01"
  ),
  endDateTime = as.POSIXct(
    "2015-01-01"
  ),
  sortBy = list(
    name = "UtteranceTimestamp",
    order = "Ascending"|"Descending"
  ),
  filters = list(
    list(
      name = "BotAliasId"|"BotVersion"|"LocaleId"|"Modality"|"Channel"|"SessionId"|"OriginatingRequestId"|"UtteranceState"|"UtteranceText",
      operator = "EQ"|"GT"|"LT",
      values = list(
        "string"
      )
    )
  ),
  maxResults = 123,
  nextToken = "string"
)