Skip to content
AWS for Query.Farm

aws.lexv2_models.list_session_analytics_data

Example SQL Queries

SELECT * FROM
aws.lexv2_models.list_session_analytics_data
WHERE
"bot_id" = 'VALUE'
AND "start_date_time" = 'VALUE'
AND "end_date_time" = 'VALUE';

Description

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 filters field to filter the results and the sortBy field to specify the values by which to sort 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.

Table Definition

Column NameColumn Data Type
bot_id Required Input Column

The unique identifier of the bot that the sessions belong to.

VARCHAR
end_date_time Required Input Column

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

TIMESTAMP_S
start_date_time Required Input Column

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

TIMESTAMP_S
filters Input Column

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

STRUCT(
    "name" VARCHAR,
    "operator" VARCHAR,
    "values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

The category by which to filter the sessions. The descriptions for each option are as follows:

  • BotAlias – The name of the bot alias.

  • BotVersion – The version of the bot.

  • LocaleId – The locale of the bot.

  • Modality – The modality of the session with the bot (audio, DTMF, or text).

  • Channel – The channel that the bot is integrated with.

  • Duration – The duration of the session.

  • conversationEndState – The final state of the session.

  • SessionId – The identifier of the session with the bot.

  • OriginatingRequestId – The identifier of the first request in a session.

  • IntentPath – The order of intents taken in a session.

filters[].operator

The operation by which to filter the category. The following operations are possible:

  • CO – Contains

  • EQ – Equals

  • GT – Greater than

  • LT – Less than

The operators that each filter supports are listed below:

  • BotAlias – EQ.

  • BotVersion – EQ.

  • LocaleId – EQ.

  • Modality – EQ.

  • Channel – EQ.

  • Duration – EQ, GT, LT.

  • conversationEndState – EQ, CO.

  • SessionId – EQ.

  • OriginatingRequestId – EQ.

  • IntentPath – EQ.

filters[].values[]
max_results Input Column

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.

BIGINT
next_token Input Column

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.

VARCHAR
sort_by Input Column

An object specifying the measure and method by which to sort the session analytics data.

STRUCT(
    "name" VARCHAR,
    "order" VARCHAR
)
Show child fields
sort_by.name

The measure by which to sort the session analytics data.

  • conversationStartTime – The date and time when the conversation began. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

  • numberOfTurns – The number of turns that the session took.

  • conversationDurationSeconds – The duration of the conversation in seconds.

sort_by.order

Specifies whether to sort the results in ascending or descending order.

_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

sessions

A list of objects, each of which contains information about a session with the bot.

STRUCT(
    "bot_alias_id" VARCHAR,
    "bot_version" VARCHAR,
    "locale_id" VARCHAR,
    "channel" VARCHAR,
    "session_id" VARCHAR,
    "conversation_start_time" TIMESTAMP_S,
    "conversation_end_time" TIMESTAMP_S,
    "conversation_duration_seconds" BIGINT,
    "conversation_end_state" VARCHAR,
    "mode" VARCHAR,
    "number_of_turns" BIGINT,
    "invoked_intent_samples" STRUCT(
        "intent_name" VARCHAR
    )[],
    "originating_request_id" VARCHAR
)[]
Show child fields
sessions[]
Show child fields
sessions[].bot_alias_id

The identifier of the alias of the bot that the session was held with.

sessions[].bot_version

The version of the bot that the session was held with.

sessions[].channel

The channel that is integrated with the bot that the session was held with.

sessions[].conversation_duration_seconds

The duration of the conversation in seconds. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

sessions[].conversation_end_state

The final state of the conversation. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

sessions[].conversation_end_time

The date and time when the conversation ended. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

sessions[].conversation_start_time

The date and time when the conversation began. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

sessions[].invoked_intent_samples[]
Show child fields
sessions[].invoked_intent_samples[].intent_name

The name of an intent that was invoked.

sessions[].locale_id

The locale of the bot that the session was held with.

sessions[].mode

The mode of the session. The possible values are as follows:

  • Speech – The session was spoken.

  • Text – The session was written.

  • DTMF – The session used a touch-tone keypad (Dual Tone Multi-Frequency).

  • MultiMode – The session used multiple modes.

sessions[].number_of_turns

The number of turns that the session took.

sessions[].originating_request_id

The identifier of the first request in a session.

sessions[].session_id

The identifier of the session.