Container for the parameters to the ListSessionAnalyticsData operation.
Retrieves a list of metadata for individual user sessions with your bot. The startDateTime
and endDateTime fields are required. These fields 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 and thesortByfield to specify the values by which to sort 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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.LexModelsV2.AmazonLexModelsV2Request
Amazon.LexModelsV2.Model.ListSessionAnalyticsDataRequest
Namespace: Amazon.LexModelsV2.Model
Assembly: AWSSDK.LexModelsV2.dll
Version: 3.x.y.z
Syntax
public class ListSessionAnalyticsDataRequest : AmazonLexModelsV2Request IAmazonWebServiceRequest
The ListSessionAnalyticsDataRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
ListSessionAnalyticsDataRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
BotId | System.String |
Gets and sets the property BotId. The identifier for the bot for which you want to retrieve session analytics. |
|
|
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 analytics. |
|
|
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. |
|
|
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. |
|
|
NextToken | System.String |
Gets and sets the property NextToken. If the response from the ListSessionAnalyticsData 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 ListSessionAnalyticsData request to return the next page of results. For a complete set of results, call the ListSessionAnalyticsData operation until the nextToken returned in the response is null. |
|
|
SortBy | Amazon.LexModelsV2.Model.SessionDataSortBy |
Gets and sets the property SortBy. An object specifying the measure and method by which to sort the session analytics data. |
|
|
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 analytics. |
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