| Column Name | Column 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_id Required Input Column
The unique identifier for the journey. | VARCHAR |
kpi_name Required Input Column
The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide. | VARCHAR |
end_time Input Column
The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019. | TIMESTAMP_S |
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 |
start_time Input Column
The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day. | TIMESTAMP_S |
_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_date_range_kpi_response
Provides the results of a query that retrieved the data for a standard engagement metric that applies to a journey, and provides information about that query. | STRUCT(
"application_id" VARCHAR,
"end_time" TIMESTAMP_S,
"journey_id" VARCHAR,
"kpi_name" VARCHAR,
"kpi_result" STRUCT(
"rows" STRUCT(
"grouped_bys" STRUCT(
"key" VARCHAR,
"type" VARCHAR,
"value" VARCHAR
)[],
"values" STRUCT(
"key" VARCHAR,
"type" VARCHAR,
"value" VARCHAR
)[]
)[]
),
"next_token" VARCHAR,
"start_time" TIMESTAMP_S
) |
Show child fields- journey_date_range_kpi_response.application_id
The unique identifier for the application that the metric applies to. - journey_date_range_kpi_response.end_time
The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive. - journey_date_range_kpi_response.journey_id
The unique identifier for the journey that the metric applies to. - journey_date_range_kpi_response.kpi_name
The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide. - journey_date_range_kpi_response.kpi_result
An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value. Show child fields- journey_date_range_kpi_response.kpi_result.rows[]
Show child fields- journey_date_range_kpi_response.kpi_result.rows[].grouped_bys[]
Show child fields- journey_date_range_kpi_response.kpi_result.rows[].grouped_bys[].key
The friendly name of the metric whose value is specified by the Value property. - journey_date_range_kpi_response.kpi_result.rows[].grouped_bys[].type
The data type of the value specified by the Value property. - journey_date_range_kpi_response.kpi_result.rows[].grouped_bys[].value
In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).
- journey_date_range_kpi_response.kpi_result.rows[].values[]
Show child fields- journey_date_range_kpi_response.kpi_result.rows[].values[].key
The friendly name of the metric whose value is specified by the Value property. - journey_date_range_kpi_response.kpi_result.rows[].values[].type
The data type of the value specified by the Value property. - journey_date_range_kpi_response.kpi_result.rows[].values[].value
In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).
- journey_date_range_kpi_response.next_token
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Journey Engagement Metrics resource because the resource returns all results in a single page. - journey_date_range_kpi_response.start_time
The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
|