Amazon Pinpoint Pinpoint Kpis API
The Pinpoint Kpis API from Amazon Pinpoint — 3 operation(s) for pinpoint kpis.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-pinpoint:amazon-pinpoint-kpis-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Amazon Pinpoint Kpis API
version: '2016-12-01'
description: Generated from AWS's published Smithy model for Amazon Pinpoint. 3 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: Kpis
paths:
/v1/apps/{ApplicationId}/kpis/daterange/{KpiName}:
get:
operationId: GetApplicationDateRangeKpi
summary: Get Application Date Range Kpi
description: Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetApplicationDateRangeKpiResponse'
'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/GetApplicationDateRangeKpiRequest'
tags:
- Kpis
/v1/apps/{ApplicationId}/campaigns/{CampaignId}/kpis/daterange/{KpiName}:
get:
operationId: GetCampaignDateRangeKpi
summary: Get Campaign Date Range Kpi
description: Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetCampaignDateRangeKpiResponse'
'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/GetCampaignDateRangeKpiRequest'
tags:
- Kpis
/v1/apps/{ApplicationId}/journeys/{JourneyId}/kpis/daterange/{KpiName}:
get:
operationId: GetJourneyDateRangeKpi
summary: Get Journey Date Range Kpi
description: Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetJourneyDateRangeKpiResponse'
'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/GetJourneyDateRangeKpiRequest'
tags:
- Kpis
components:
schemas:
CampaignDateRangeKpiResponse:
type: object
properties:
ApplicationId:
type: string
description: The unique identifier for the application that the metric applies to.
CampaignId:
type: string
description: The unique identifier for the campaign that the metric applies to.
EndTime:
type: string
format: date-time
description: 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.
KpiName:
type: string
description: 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:
$ref: '#/components/schemas/BaseKpiResult'
NextToken:
type: string
description: 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 Campaign Metrics resource because the resource returns all results in a single page.
StartTime:
type: string
format: date-time
description: 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.
required:
- ApplicationId
- CampaignId
- EndTime
- KpiName
- KpiResult
- StartTime
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.
GetCampaignDateRangeKpiResponse:
type: object
properties:
CampaignDateRangeKpiResponse:
$ref: '#/components/schemas/CampaignDateRangeKpiResponse'
required:
- CampaignDateRangeKpiResponse
JourneyDateRangeKpiResponse:
type: object
properties:
ApplicationId:
type: string
description: The unique identifier for the application that the metric applies to.
EndTime:
type: string
format: date-time
description: 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:
type: string
description: The unique identifier for the journey that the metric applies to.
KpiName:
type: string
description: 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:
$ref: '#/components/schemas/BaseKpiResult'
NextToken:
type: string
description: 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:
type: string
format: date-time
description: 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.
required:
- ApplicationId
- EndTime
- JourneyId
- KpiName
- KpiResult
- StartTime
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.
ResultRow:
type: object
properties:
GroupedBys:
type: array
items:
$ref: '#/components/schemas/ResultRowValue'
description: 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:
type: array
items:
$ref: '#/components/schemas/ResultRowValue'
description: An array of objects that provides pre-aggregated values for a standard metric that applies to an application, campaign, or journey.
required:
- GroupedBys
- Values
GetJourneyDateRangeKpiRequest:
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.
EndTime:
type: string
format: date-time
description: '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.'
JourneyId:
type: string
description: The unique identifier for the journey.
KpiName:
type: string
description: 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.
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.
StartTime:
type: string
format: date-time
description: '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.'
required:
- ApplicationId
- JourneyId
- KpiName
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.
GetJourneyDateRangeKpiResponse:
type: object
properties:
JourneyDateRangeKpiResponse:
$ref: '#/components/schemas/JourneyDateRangeKpiResponse'
required:
- JourneyDateRangeKpiResponse
GetApplicationDateRangeKpiResponse:
type: object
properties:
ApplicationDateRangeKpiResponse:
$ref: '#/components/schemas/ApplicationDateRangeKpiResponse'
required:
- ApplicationDateRangeKpiResponse
BaseKpiResult:
type: object
properties:
Rows:
type: array
items:
$ref: '#/components/schemas/ResultRow'
description: 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.
required:
- Rows
GetApplicationDateRangeKpiRequest:
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.
EndTime:
type: string
format: date-time
description: '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.'
KpiName:
type: string
description: 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.
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.
StartTime:
type: string
format: date-time
description: '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.'
required:
- ApplicationId
- KpiName
GetCampaignDateRangeKpiRequest:
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.
CampaignId:
type: string
description: The unique identifier for the campaign.
EndTime:
type: string
format: date-time
description: '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.'
KpiName:
type: string
description: 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.
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.
StartTime:
type: string
format: date-time
description: '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.'
required:
- ApplicationId
- CampaignId
- KpiName
ApplicationDateRangeKpiResponse:
type: object
properties:
ApplicationId:
type: string
description: The unique identifier for the application that the metric applies to.
EndTime:
type: string
format: date-time
description: 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.
KpiName:
type: string
description: 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:
$ref: '#/components/schemas/BaseKpiResult'
NextToken:
type: string
description: 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 Application Metrics resource because the resource returns all results in a single page.
StartTime:
type: string
format: date-time
description: 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.
required:
- ApplicationId
- EndTime
- KpiName
- KpiResult
- StartTime
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.
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.
ResultRowValue:
type: object
properties:
Key:
type: string
description: The friendly name of the metric whose value is specified by the Value property.
Type:
type: string
description: The data type of the value specified by the Value property.
Value:
type: string
description: 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).
required:
- Key
- Type
- Value
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.
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)