IAmazonLexModelsV2.ListSessionMetrics Method (ListSessionMetricsRequest)

Retrieves summary metrics for the user sessions with your bot. The following fields are required:

metrics – A list of AnalyticsSessionMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order.
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, the groupBy field to specify categories by which to group the results, and the binBy 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 the nextToken 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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to ListSessionMetricsAsync.

Namespace: Amazon.LexModelsV2
Assembly: AWSSDK.LexModelsV2.dll
Version: 3.x.y.z

Syntax

public abstract ListSessionMetricsResponse ListSessionMetrics(
         ListSessionMetricsRequest request
)

request: Type: Amazon.LexModelsV2.Model.ListSessionMetricsRequest

Container for the necessary parameters to execute the ListSessionMetrics service method.

The response from the ListSessionMetrics service method, as returned by LexModelsV2.

Exception	Condition
InternalServerException	The service encountered an unexpected condition. Try your request again.
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.
ServiceQuotaExceededException	You have reached a quota for your bot.
ThrottlingException	Your request rate is too high. Reduce the frequency of requests.
ValidationException	One of the input parameters in your request isn't valid. Check the parameters and try your request again.

.NET Framework:
Supported in: 4.5 and newer, 3.5