/AWS1/CL_LM2=>LISTUTTERANCEMETRICS()
¶
About ListUtteranceMetrics¶
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 summary metrics for the utterances in your bot. The following fields are required:
-
metrics
– A list of AnalyticsUtteranceMetric objects. In each object, use thename
field to specify the metric to calculate, thestatistic
field to specify whether to calculate theSum
,Average
, orMax
number, and theorder
field to specify whether to sort the results inAscending
orDescending
order. -
startDateTime
andendDateTime
– 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, thegroupBy
field to specify categories by which to group the results, and thebinBy
field to specify time intervals by which to group the results. -
Use the
maxResults
field to limit the number of results to return in a single response and thenextToken
field to return the next batch of results if the response does not return the full set of results.
Note that an order
field exists in both binBy
and metrics
. Currently, you can specify it in either field, but not in both.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_BOTID
TYPE /AWS1/LM2ID
/AWS1/LM2ID
¶
The identifier for the bot for which you want to retrieve utterance metrics.
IV_STARTDATETIME
TYPE /AWS1/LM2TIMESTAMP
/AWS1/LM2TIMESTAMP
¶
The date and time that marks the beginning of the range of time for which you want to see utterance metrics.
IV_ENDDATETIME
TYPE /AWS1/LM2TIMESTAMP
/AWS1/LM2TIMESTAMP
¶
The date and time that marks the end of the range of time for which you want to see utterance metrics.
IT_METRICS
TYPE /AWS1/CL_LM2ALYSUTTERANCEMET00=>TT_ANALYTICSUTTERANCEMETRICS
TT_ANALYTICSUTTERANCEMETRICS
¶
A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
Optional arguments:¶
IT_BINBY
TYPE /AWS1/CL_LM2ANALYTICSBINBYSPEC=>TT_ANALYTICSBINBYLIST
TT_ANALYTICSBINBYLIST
¶
A list of objects, each of which contains specifications for organizing the results by time.
IT_GROUPBY
TYPE /AWS1/CL_LM2ALYSUTTERANCEGRB00=>TT_ALYSUTTERANCEGROUPBYLIST
TT_ALYSUTTERANCEGROUPBYLIST
¶
A list of objects, each of which specifies how to group the results. You can group by the following criteria:
UtteranceText
– The transcription of the utterance.
UtteranceState
– The state of the utterance. The possible states are detailed in Key definitions in the user guide.
IT_ATTRIBUTES
TYPE /AWS1/CL_LM2ALYSUTTERANCEATTR=>TT_ANALYTICSUTTERANCEATTRS
TT_ANALYTICSUTTERANCEATTRS
¶
A list containing attributes related to the utterance that you want the response to return. The following attributes are possible:
LastUsedIntent
– The last used intent at the time of the utterance.
IT_FILTERS
TYPE /AWS1/CL_LM2ALYSUTTERANCEFILT=>TT_ANALYTICSUTTERANCEFILTERS
TT_ANALYTICSUTTERANCEFILTERS
¶
A list of objects, each of which describes a condition by which you want to filter the results.
IV_MAXRESULTS
TYPE /AWS1/LM2MAXRESULTS
/AWS1/LM2MAXRESULTS
¶
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.
IV_NEXTTOKEN
TYPE /AWS1/LM2NEXTTOKEN
/AWS1/LM2NEXTTOKEN
¶
If the response from the ListUtteranceMetrics 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 ListUtteranceMetrics request to return the next page of results. For a complete set of results, call the ListUtteranceMetrics operation until the nextToken returned in the response is null.