Journey Engagement Metrics
A journey engagement metric is a measurable value, also referred to as a key performance indicator (KPI), that can help you monitor and assess the performance of a journey. For example, you can use a journey engagement metric to access data about how many messages were sent by a journey or how many of those messages were delivered to participants. Amazon Pinpoint automatically collects, aggregates, and stores this data for all of your journeys.
The Journey Engagement Metrics resource represents a collection of standard metrics that apply to a journey. As part of the Amazon Pinpoint Analytics APIs, this resource provides you with programmatic access to pre-aggregated data for each of these metrics. For a list of journey engagement metrics that are currently supported, see the Amazon Pinpoint Developer Guide.
You can use the Journey Engagement Metrics resource to retrieve pre-aggregated data for a standard metric that applies to an individual journey.
URI
/v1/apps/application-id/journeys/journey-id/kpis/daterange/kpi-name
HTTP methods
GET
Operation ID: GetJourneyDateRangeKpi
Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.
| Name | Type | Required | Description |
|---|---|---|---|
journey-id | String | True | The unique identifier for the journey. |
application-id | String | True | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
kpi-name | String | True | 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
|
| Name | Type | Required | Description |
|---|---|---|---|
accept | String | False | Indicates which content types, expressed as MIME types, the client understands. |
| Name | Type | Required | Description |
|---|---|---|---|
next-token | String | False | The |
end-time | String | False | 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:
|
start-time | String | False | 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:
|
page-size | String | False | 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. |
| Status code | Response model | Description |
|---|---|---|
200 | JourneyDateRangeKpiResponse | The request succeeded. |
400 | MessageBody | The request contains a syntax error (BadRequestException). |
403 | MessageBody | The request was denied because access to the specified resource is forbidden (ForbiddenException). |
404 | MessageBody | The request failed because the specified resource was not found (NotFoundException). |
405 | MessageBody | The request failed because the method is not allowed for the specified resource (MethodNotAllowedException). |
413 | MessageBody | The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException). |
429 | MessageBody | The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException). |
500 | MessageBody | The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException). |
OPTIONS
Retrieves information about the communication requirements and options that are available for the Journey Engagement Metrics resource.
| Name | Type | Required | Description |
|---|---|---|---|
journey-id | String | True | The unique identifier for the journey. |
application-id | String | True | The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. |
kpi-name | String | True | 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
|
| Status code | Response model | Description |
|---|---|---|
200 | None | The request succeeded. |
Schemas
Response bodies
{
"KpiName": "string",
"KpiResult": {
"Rows": [
{
"GroupedBys": [
{
"Key": "string",
"Value": "string",
"Type": "string"
}
],
"Values": [
{
"Key": "string",
"Value": "string",
"Type": "string"
}
]
}
]
},
"NextToken": "string",
"ApplicationId": "string",
"JourneyId": "string",
"StartTime": "string",
"EndTime": "string"
}Properties
BaseKpiResult
Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.
| Property | Type | Required | Description |
|---|---|---|---|
Rows | Array of type ResultRow | True | An array of objects that provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey. |
JourneyDateRangeKpiResponse
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.
| Property | Type | Required | Description |
|---|---|---|---|
ApplicationId | string | True | The unique identifier for the application that the metric applies to. |
EndTime | string | True | 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. |
JourneyId | string | True | The unique identifier for the journey that the metric applies to. |
KpiName | string | True | 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. |
KpiResult | True | An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value. | |
NextToken | string | False | 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. |
StartTime | string | True | 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. |
MessageBody
Provides information about an API request or response.
| Property | Type | Required | Description |
|---|---|---|---|
Message | string | False | The message that's returned from the API. |
RequestID | string | False | The unique identifier for the request or response. |
ResultRow
Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.
| Property | Type | Required | Description |
|---|---|---|---|
GroupedBys | Array of type ResultRowValue | True | An array of objects that defines the field and field values that were used to group data in a result set that contains multiple results. This value is null if the data in a result set isn’t grouped. |
Values | Array of type ResultRowValue | True | An array of objects that provides pre-aggregated values for a standard metric that applies to an application, campaign, or journey. |
ResultRowValue
Provides a single value and metadata about that value as part of an array of query results for a standard metric that applies to an application, campaign, or journey.
| Property | Type | Required | Description |
|---|---|---|---|
Key | string | True | The friendly name of the metric whose value is specified by the
|
Type | string | True | The data type of the value specified by the |
Value | string | True | In a |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
GetJourneyDateRangeKpi
