Journey Engagement Metrics - Amazon Pinpoint

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.

Path parameters
NameTypeRequiredDescription
journey-idStringTrue

The unique identifier for the journey.

application-idStringTrue

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

kpi-nameStringTrue

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.

Header parameters
NameTypeRequiredDescription
acceptStringFalse

Indicates which content types, expressed as MIME types, the client understands.

Query parameters
NameTypeRequiredDescription
next-tokenStringFalse

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.

end-timeStringFalse

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.

start-timeStringFalse

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.

page-sizeStringFalse

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.

Responses
Status codeResponse modelDescription
200JourneyDateRangeKpiResponse

The request succeeded.

400MessageBody

The request contains a syntax error (BadRequestException).

403MessageBody

The request was denied because access to the specified resource is forbidden (ForbiddenException).

404MessageBody

The request failed because the specified resource was not found (NotFoundException).

405MessageBody

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

413MessageBody

The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).

429MessageBody

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

500MessageBody

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.

Path parameters
NameTypeRequiredDescription
journey-idStringTrue

The unique identifier for the journey.

application-idStringTrue

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

kpi-nameStringTrue

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.

Responses
Status codeResponse modelDescription
200None

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" }
{ "RequestID": "string", "Message": "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.

PropertyTypeRequiredDescription
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.

PropertyTypeRequiredDescription
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

BaseKpiResult

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.

PropertyTypeRequiredDescription
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.

PropertyTypeRequiredDescription
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.

PropertyTypeRequiredDescription
Key

string

True

The friendly name of the metric whose value is specified by the Value property.

Type

string

True

The data type of the value specified by the Value property.

Value

string

True

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).

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

GetJourneyDateRangeKpi