journey_run_execution_metrics
Creates, updates, deletes, gets or lists a journey_run_execution_metrics resource.
Overview
| Name | journey_run_execution_metrics |
| Type | Resource |
| Id | aws.pinpoint.journey_run_execution_metrics |
Fields
The following fields are returned by SELECT queries:
- get_journey_run_execution_metrics
| Name | Datatype | Description |
|---|---|---|
application_id | string | The unique identifier for the application that the metric applies to. |
journey_id | string | The unique identifier for the journey that the metric applies to. |
last_evaluated_time | string | The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey run and updated the data for the metric. |
metrics | object | A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Standard Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide. |
run_id | string | The unique identifier for the journey run that the metric applies to. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_journey_run_execution_metrics | select | application-id, journey-id, run-id, region | next-token, page-size | Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
application-id | string | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
journey-id | string | The unique identifier for the journey. |
region | string | AWS region (default: us-east-1) |
run-id | string | The unique identifier for the journey run. |
next-token | string | 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. |
page-size | string | 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. |
SELECT examples
- get_journey_run_execution_metrics
Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey.
SELECT
application_id,
journey_id,
last_evaluated_time,
metrics,
run_id
FROM aws.pinpoint.journey_run_execution_metrics
WHERE `application-id` = '{{ application-id }}' -- required
AND `journey-id` = '{{ journey-id }}' -- required
AND `run-id` = '{{ run-id }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `page-size` = '{{ page-size }}'
;