Amazon Pinpoint Pinpoint Execution Metrics API

The Pinpoint Execution Metrics API from Amazon Pinpoint — 4 operation(s) for pinpoint execution metrics.

Documentation GitHub OpenAPI

Operations 4

GET /v1/apps/{ApplicationId}/journeys/{JourneyId}/activities/{JourneyActivityId}/execution-metrics Get Journey Execution Activity Metrics #

GET /v1/apps/{ApplicationId}/journeys/{JourneyId}/execution-metrics Get Journey Execution Metrics #

GET /v1/apps/{ApplicationId}/journeys/{JourneyId}/runs/{RunId}/activities/{JourneyActivityId}/execution-metrics Get Journey Run Execution Activity Metrics #

GET /v1/apps/{ApplicationId}/journeys/{JourneyId}/runs/{RunId}/execution-metrics Get Journey Run Execution Metrics #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/amazon-pinpoint/openapi/amazon-pinpoint-execution-metrics-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-pinpoint:amazon-pinpoint-execution-metrics-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Amazon Pinpoint Execution Metrics API
  version: '2016-12-01'
  description: Generated from AWS's published Smithy model for Amazon Pinpoint. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://pinpoint.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Execution Metrics
paths:
  /v1/apps/{ApplicationId}/journeys/{JourneyId}/activities/{JourneyActivityId}/execution-metrics:
    get:
      operationId: GetJourneyExecutionActivityMetrics
      summary: Get Journey Execution Activity Metrics
      description: Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetJourneyExecutionActivityMetricsResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '405':
          description: MethodNotAllowedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowedException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '413':
          description: PayloadTooLargeException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayloadTooLargeException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetJourneyExecutionActivityMetricsRequest'
      tags:
      - Execution Metrics
  /v1/apps/{ApplicationId}/journeys/{JourneyId}/execution-metrics:
    get:
      operationId: GetJourneyExecutionMetrics
      summary: Get Journey Execution Metrics
      description: Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetJourneyExecutionMetricsResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '405':
          description: MethodNotAllowedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowedException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '413':
          description: PayloadTooLargeException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayloadTooLargeException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetJourneyExecutionMetricsRequest'
      tags:
      - Execution Metrics
  /v1/apps/{ApplicationId}/journeys/{JourneyId}/runs/{RunId}/activities/{JourneyActivityId}/execution-metrics:
    get:
      operationId: GetJourneyRunExecutionActivityMetrics
      summary: Get Journey Run Execution Activity Metrics
      description: Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetJourneyRunExecutionActivityMetricsResponse'
              example:
                JourneyRunExecutionActivityMetricsResponse:
                  ApplicationId: '11111111112222222222333333333344'
                  JourneyId: aaaaaaaaaabbbbbbbbbbccccccccccdd
                  RunId: '99999999998888888888777777777766'
                  JourneyActivityId: AAAAAAAAAA
                  ActivityType: EMAIL
                  LastEvaluatedTime: '2000-01-01T00:00:05.000Z'
                  Metrics:
                    SUCCESS: '1'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '405':
          description: MethodNotAllowedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowedException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '413':
          description: PayloadTooLargeException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayloadTooLargeException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetJourneyRunExecutionActivityMetricsRequest'
            example:
              ApplicationId: '11111111112222222222333333333344'
              JourneyId: aaaaaaaaaabbbbbbbbbbccccccccccdd
              RunId: '99999999998888888888777777777766'
              JourneyActivityId: AAAAAAAAAA
      tags:
      - Execution Metrics
  /v1/apps/{ApplicationId}/journeys/{JourneyId}/runs/{RunId}/execution-metrics:
    get:
      operationId: GetJourneyRunExecutionMetrics
      summary: Get Journey Run Execution Metrics
      description: Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetJourneyRunExecutionMetricsResponse'
              example:
                JourneyRunExecutionMetricsResponse:
                  ApplicationId: '11111111112222222222333333333344'
                  JourneyId: aaaaaaaaaabbbbbbbbbbccccccccccdd
                  RunId: '99999999998888888888777777777766'
                  LastEvaluatedTime: '2000-01-01T00:00:05.000Z'
                  Metrics:
                    ENDPOINT_PRODUCED: '1'
                    ENDPOINT_ENTERED: '1'
                    ENDPOINT_LEFT: '1'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '405':
          description: MethodNotAllowedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowedException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '413':
          description: PayloadTooLargeException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayloadTooLargeException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetJourneyRunExecutionMetricsRequest'
            example:
              ApplicationId: '11111111112222222222333333333344'
              JourneyId: aaaaaaaaaabbbbbbbbbbccccccccccdd
              RunId: '99999999998888888888777777777766'
      tags:
      - Execution Metrics
components:
  schemas:
    GetJourneyRunExecutionActivityMetricsResponse:
      type: object
      properties:
        JourneyRunExecutionActivityMetricsResponse:
          $ref: '#/components/schemas/JourneyRunExecutionActivityMetricsResponse'
      required:
      - JourneyRunExecutionActivityMetricsResponse
    NotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: The message that's returned from the API.
        RequestID:
          type: string
          description: The unique identifier for the request or response.
    GetJourneyExecutionActivityMetricsResponse:
      type: object
      properties:
        JourneyExecutionActivityMetricsResponse:
          $ref: '#/components/schemas/JourneyExecutionActivityMetricsResponse'
      required:
      - JourneyExecutionActivityMetricsResponse
    GetJourneyRunExecutionMetricsResponse:
      type: object
      properties:
        JourneyRunExecutionMetricsResponse:
          $ref: '#/components/schemas/JourneyRunExecutionMetricsResponse'
      required:
      - JourneyRunExecutionMetricsResponse
    JourneyExecutionActivityMetricsResponse:
      type: object
      properties:
        ActivityType:
          type: string
          description: 'The type of activity that the metric applies to. Possible values are: CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey. HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of participants. MESSAGE – For an email activity, which is an activity that sends an email message to participants. MULTI_CONDITIONAL_SPLIT – For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey. RANDOM_SPLIT – For a random'
        ApplicationId:
          type: string
          description: The unique identifier for the application that the metric applies to.
        JourneyActivityId:
          type: string
          description: The unique identifier for the activity that the metric applies to.
        JourneyId:
          type: string
          description: The unique identifier for the journey that the metric applies to.
        LastEvaluatedTime:
          type: string
          description: The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity and updated the data for the metric.
        Metrics:
          type: object
          additionalProperties:
            type: string
          description: A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.
      required:
      - ActivityType
      - ApplicationId
      - JourneyActivityId
      - JourneyId
      - LastEvaluatedTime
      - Metrics
    GetJourneyExecutionMetricsRequest:
      type: object
      properties:
        ApplicationId:
          type: string
          description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
        JourneyId:
          type: string
          description: The unique identifier for the journey.
        NextToken:
          type: string
          description: 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.
        PageSize:
          type: string
          description: 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.
      required:
      - ApplicationId
      - JourneyId
    PayloadTooLargeException:
      type: object
      properties:
        Message:
          type: string
          description: The message that's returned from the API.
        RequestID:
          type: string
          description: The unique identifier for the request or response.
    MethodNotAllowedException:
      type: object
      properties:
        Message:
          type: string
          description: The message that's returned from the API.
        RequestID:
          type: string
          description: The unique identifier for the request or response.
    GetJourneyExecutionActivityMetricsRequest:
      type: object
      properties:
        ApplicationId:
          type: string
          description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
        JourneyActivityId:
          type: string
          description: The unique identifier for the journey activity.
        JourneyId:
          type: string
          description: The unique identifier for the journey.
        NextToken:
          type: string
          description: 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.
        PageSize:
          type: string
          description: 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.
      required:
      - ApplicationId
      - JourneyActivityId
      - JourneyId
    GetJourneyRunExecutionMetricsRequest:
      type: object
      properties:
        ApplicationId:
          type: string
          description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
        JourneyId:
          type: string
          description: The unique identifier for the journey.
        NextToken:
          type: string
          description: 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.
        PageSize:
          type: string
          description: 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.
        RunId:
          type: string
          description: The unique identifier for the journey run.
      required:
      - ApplicationId
      - JourneyId
      - RunId
    GetJourneyRunExecutionActivityMetricsRequest:
      type: object
      properties:
        ApplicationId:
          type: string
          description: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
        JourneyActivityId:
          type: string
          description: The unique identifier for the journey activity.
        JourneyId:
          type: string
          description: The unique identifier for the journey.
        NextToken:
          type: string
          description: 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.
        PageSize:
          type: string
          description: 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.
        RunId:
          type: string
          description: The unique identifier for the journey run.
      required:
      - ApplicationId
      - JourneyActivityId
      - JourneyId
      - RunId
    InternalServerErrorException:
      type: object
      properties:
        Message:
          type: string
          description: The message that's returned from the API.
        RequestID:
          type: string
          description: The unique identifier for the request or response.
    ForbiddenException:
      type: object
      properties:
        Message:
          type: string
          description: The message that's returned from the API.
        RequestID:
          type: string
          description: The unique identifier for the request or response.
    JourneyRunExecutionActivityMetricsResponse:
      type: object
      properties:
        ActivityType:
          type: string
          description: 'The type of activity that the metric applies to. Possible values are: CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey. HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of participants. MESSAGE – For an email activity, which is an activity that sends an email message to participants. MULTI_CONDITIONAL_SPLIT – For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey. RANDOM_SPLIT – For a random'
        ApplicationId:
          type: string
          description: The unique identifier for the application that the metric applies to.
        JourneyActivityId:
          type: string
          description: The unique identifier for the activity that the metric applies to.
        JourneyId:
          type: string
          description: The unique identifier for the journey that the metric applies to.
        LastEvaluatedTime:
          type: string
          description: The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity for this journey run and updated the data for the metric.
        Metrics:
          type: object
          additionalProperties:
            type: string
          description: A JSON object that contains the results of the query. For information about the structure and contents of the results, see see Standard Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide.
        RunId:
          type: string
          description: The unique identifier for the journey run that the metric applies to.
      required:
      - ActivityType
      - ApplicationId
      - JourneyActivityId
      - JourneyId
      - LastEvaluatedTime
      - Metrics
      - RunId
    TooManyRequestsException:
      type: object
      properties:
        Message:
          type: string
          description: The message that's returned from the API.
        RequestID:
          type: string
          description: The unique identifier for the request or response.
    JourneyRunExecutionMetricsResponse:
      type: object
      properties:
        ApplicationId:
          type: string
          description: The unique identifier for the application that the metric applies to.
        JourneyId:
          type: string
          description: The unique identifier for the journey that the metric applies to.
        LastEvaluatedTime:
          type: string
          description: The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey run and updated the data for the metric.
        Metrics:
          type: object
          additionalProperties:
            type: string
          description: 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.
        RunId:
          type: string
          description: The unique identifier for the journey run that the metric applies to.
      required:
      - ApplicationId
      - JourneyId
      - LastEvaluatedTime
      - Metrics
      - RunId
    BadRequestException:
      type: object
      properties:
        Message:
          type: string
          description: The message that's returned from the API.
        RequestID:
          type: string
          description: The unique identifier for the request or response.
    JourneyExecutionMetricsResponse:
      type: object
      properties:
        ApplicationId:
          type: string
          description: The unique identifier for the application that the metric applies to.
        JourneyId:
          type: string
          description: The unique identifier for the journey that the metric applies to.
        LastEvaluatedTime:
          type: string
          description: The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for the metric.
        Metrics:
          type: object
          additionalProperties:
            type: string
          description: 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.
      required:
      - ApplicationId
      - JourneyId
      - LastEvaluatedTime
      - Metrics
    GetJourneyExecutionMetricsResponse:
      type: object
      properties:
        JourneyExecutionMetricsResponse:
          $ref: '#/components/schemas/JourneyExecutionMetricsResponse'
      required:
      - JourneyExecutionMetricsResponse
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: mobiletargeting
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/pinpoint/service/2016-12-01/pinpoint-2016-12-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)