Container for the parameters to the ListSessionMetrics operation. 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 thenamefield to specify the metric to calculate, thestatisticfield to specify whether to calculate theSum,Average, orMaxnumber, and theorderfield to specify whether to sort the results inAscendingorDescendingorder. -
startDateTimeandendDateTime– 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
filtersfield to filter the results, thegroupByfield to specify categories by which to group the results, and thebinByfield to specify time intervals by which to group the results. -
Use the
maxResultsfield to limit the number of results to return in a single response and thenextTokenfield 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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.LexModelsV2.AmazonLexModelsV2Request
Amazon.LexModelsV2.Model.ListSessionMetricsRequest
Namespace: Amazon.LexModelsV2.Model
Assembly: AWSSDK.LexModelsV2.dll
Version: 3.x.y.z
Syntax
public class ListSessionMetricsRequest : AmazonLexModelsV2Request IAmazonWebServiceRequest
The ListSessionMetricsRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
ListSessionMetricsRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
BinBy | System.Collections.Generic.List<Amazon.LexModelsV2.Model.AnalyticsBinBySpecification> |
Gets and sets the property BinBy. A list of objects, each of which contains specifications for organizing the results by time. |
|
|
BotId | System.String |
Gets and sets the property BotId. The identifier for the bot for which you want to retrieve session metrics. |
|
|
EndDateTime | System.DateTime |
Gets and sets the property EndDateTime. The date and time that marks the end of the range of time for which you want to see session metrics. |
|
|
Filters | System.Collections.Generic.List<Amazon.LexModelsV2.Model.AnalyticsSessionFilter> |
Gets and sets the property Filters. A list of objects, each of which describes a condition by which you want to filter the results. |
|
|
GroupBy | System.Collections.Generic.List<Amazon.LexModelsV2.Model.AnalyticsSessionGroupBySpecification> |
Gets and sets the property GroupBy. A list of objects, each of which specifies how to group the results. You can group by the following criteria:
|
|
|
MaxResults | System.Int32 |
Gets and sets the property 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. |
|
|
Metrics | System.Collections.Generic.List<Amazon.LexModelsV2.Model.AnalyticsSessionMetric> |
Gets and sets the property Metrics. 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. |
|
|
NextToken | System.String |
Gets and sets the property NextToken. If the response from the ListSessionMetrics 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 ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics operation until the nextToken returned in the response is null. |
|
|
StartDateTime | System.DateTime |
Gets and sets the property StartDateTime. The date and time that marks the beginning of the range of time for which you want to see session metrics. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5