ListSessionMetricsCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { LexModelsV2Client, ListSessionMetricsCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import
// const { LexModelsV2Client, ListSessionMetricsCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import
const client = new LexModelsV2Client(config);
const input = { // ListSessionMetricsRequest
  botId: "STRING_VALUE", // required
  startDateTime: new Date("TIMESTAMP"), // required
  endDateTime: new Date("TIMESTAMP"), // required
  metrics: [ // AnalyticsSessionMetrics // required
    { // AnalyticsSessionMetric
      name: "Count" || "Success" || "Failure" || "Dropped" || "Duration" || "TurnsPerConversation" || "Concurrency", // required
      statistic: "Sum" || "Avg" || "Max", // required
      order: "Ascending" || "Descending",
    },
  ],
  binBy: [ // AnalyticsBinByList
    { // AnalyticsBinBySpecification
      name: "ConversationStartTime" || "UtteranceTimestamp", // required
      interval: "OneHour" || "OneDay", // required
      order: "Ascending" || "Descending",
    },
  ],
  groupBy: [ // AnalyticsSessionGroupByList
    { // AnalyticsSessionGroupBySpecification
      name: "ConversationEndState" || "LocaleId", // required
    },
  ],
  filters: [ // AnalyticsSessionFilters
    { // AnalyticsSessionFilter
      name: "BotAliasId" || "BotVersion" || "LocaleId" || "Modality" || "Channel" || "Duration" || "ConversationEndState" || "SessionId" || "OriginatingRequestId" || "IntentPath", // required
      operator: "EQ" || "GT" || "LT", // required
      values: [ // AnalyticsFilterValues // required
        "STRING_VALUE",
      ],
    },
  ],
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
};
const command = new ListSessionMetricsCommand(input);
const response = await client.send(command);
// { // ListSessionMetricsResponse
//   botId: "STRING_VALUE",
//   results: [ // AnalyticsSessionResults
//     { // AnalyticsSessionResult
//       binKeys: [ // AnalyticsBinKeys
//         { // AnalyticsBinKey
//           name: "ConversationStartTime" || "UtteranceTimestamp",
//           value: Number("long"),
//         },
//       ],
//       groupByKeys: [ // AnalyticsSessionGroupByKeys
//         { // AnalyticsSessionGroupByKey
//           name: "ConversationEndState" || "LocaleId",
//           value: "STRING_VALUE",
//         },
//       ],
//       metricsResults: [ // AnalyticsSessionMetricResults
//         { // AnalyticsSessionMetricResult
//           name: "Count" || "Success" || "Failure" || "Dropped" || "Duration" || "TurnsPerConversation" || "Concurrency",
//           statistic: "Sum" || "Avg" || "Max",
//           value: Number("double"),
//         },
//       ],
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListSessionMetricsCommand Input

See ListSessionMetricsCommandInput for more details

Parameter
Type
Description
botId
Required
string | undefined

The identifier for the bot for which you want to retrieve session metrics.

endDateTime
Required
Date | undefined

The date and time that marks the end of the range of time for which you want to see session metrics.

metrics
Required
AnalyticsSessionMetric[] | undefined

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.

startDateTime
Required
Date | undefined

The date and time that marks the beginning of the range of time for which you want to see session metrics.

binBy
AnalyticsBinBySpecification[] | undefined

A list of objects, each of which contains specifications for organizing the results by time.

filters
AnalyticsSessionFilter[] | undefined

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

groupBy
AnalyticsSessionGroupBySpecification[] | undefined

A list of objects, each of which specifies how to group the results. You can group by the following criteria:

  • ConversationEndState – The final state of the conversation. The possible end states are detailed in Key definitions  in the user guide.

  • LocaleId – The unique identifier of the bot locale.

maxResults
number | undefined

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
string | undefined

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.

ListSessionMetricsCommand Output

See ListSessionMetricsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
botId
string | undefined

The identifier for the bot for which you retrieved session metrics.

nextToken
string | undefined

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.

results
AnalyticsSessionResult[] | undefined

The results for the session metrics.

Throws

Name
Fault
Details
InternalServerException
server

The service encountered an unexpected condition. Try your request again.

PreconditionFailedException
client

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
client

You have reached a quota for your bot.

ThrottlingException
client

Your request rate is too high. Reduce the frequency of requests.

ValidationException
client

One of the input parameters in your request isn't valid. Check the parameters and try your request again.

LexModelsV2ServiceException
Base exception class for all service exceptions from LexModelsV2 service.