Skip to content
AWS for Query.Farm

aws.pinpoint.get_journey_execution_activity_metrics

Example SQL Queries

SELECT * FROM
aws.pinpoint.get_journey_execution_activity_metrics
WHERE
"journey_activity_id" = 'VALUE'
AND "application_id" = 'VALUE'
AND "journey_id" = 'VALUE';

Description

Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.

Table Definition

Column NameColumn Data Type
application_id Required Input Column

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

VARCHAR
journey_activity_id Required Input Column

The unique identifier for the journey activity.

VARCHAR
journey_id Required Input Column

The unique identifier for the journey.

VARCHAR
next_token Input Column

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

VARCHAR
page_size Input Column

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

VARCHAR
_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.

_aws_region Input Column

The AWS region to use.

VARCHAR
journey_execution_activity_metrics_response

Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity, and provides information about that query.

STRUCT(
    "activity_type" VARCHAR,
    "application_id" VARCHAR,
    "journey_activity_id" VARCHAR,
    "journey_id" VARCHAR,
    "last_evaluated_time" VARCHAR,
    "metrics" MAP(VARCHAR, VARCHAR)
)
Show child fields
journey_execution_activity_metrics_response.activity_type

The type of activity that the metric applies to. Possible values are:

  • CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.

  • HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.

  • MESSAGE – For an email activity, which is an activity that sends an email message to participants.

  • MULTI_CONDITIONAL_SPLIT – For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.

  • RANDOM_SPLIT – For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.

  • WAIT – For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

journey_execution_activity_metrics_response.application_id

The unique identifier for the application that the metric applies to.

journey_execution_activity_metrics_response.journey_activity_id

The unique identifier for the activity that the metric applies to.

journey_execution_activity_metrics_response.journey_id

The unique identifier for the journey that the metric applies to.

journey_execution_activity_metrics_response.last_evaluated_time

The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity and updated the data for the metric.

journey_execution_activity_metrics_response.metrics

A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.