Amazon Pinpoint
REST API Reference

Journey Execution Metrics

A journey execution metric is a measurable value, also referred to as a key performance indicator (KPI), that can help you assess the status of participants in a journey. For example, you can use this type of metric to determine how many participants are actively proceeding through the activities in the journey. Amazon Pinpoint automatically collects, aggregates, and stores this data for all of your journeys.

The Journey Execution Metrics resource represents a collection of standard execution 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 metrics that are currently supported, see the Amazon Pinpoint Developer Guide.

You can use the Journey Execution Metrics resource to retrieve pre-aggregated data for standard execution metrics that apply to a journey. To retrieve data for a standard metric that applies to an individual activity in a journey, use the Journey Activity Execution Metrics resource.

URI

/v1/apps/application-id/journeys/journey-id/execution-metrics

HTTP Methods

GET

Operation ID: GetJourneyExecutionMetrics

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

Path Parameters

Name Type Required Description
application-id String True

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

journey-id String True

The unique identifier for the journey.

Header Parameters

Name Type Required Description
accept String False

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

Query Parameters

Name Type Required Description
page-size String False

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

next-token String False

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

Responses

Status Code Response Model Description
200 JourneyExecutionMetricsResponse

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

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 Execution Metrics resource.

Responses

Status Code Response Model Description
200 None

The request succeeded.

Schemas

Response Bodies

Example JourneyExecutionMetricsResponse

{ "ApplicationId": "string", "JourneyId": "string", "LastEvaluatedTime": "string", "Metrics": { } }

Example MessageBody

{ "RequestID": "string", "Message": "string" }

Properties

JourneyExecutionMetricsResponse

Provides the results of a query that retrieved the data for a standard execution 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.

JourneyId

string

True

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

LastEvaluatedTime

string

True

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

Metrics

object

True

A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.

MessageBody

Provides information about an API request or response.

Property Type Required Description
RequestID

string

False

The unique identifier for the request or response.

Message

string

False

The message that's returned from the API.

See Also

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

GetJourneyExecutionMetrics