Name Type Required Description
next-token String False 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-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:
2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.
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:
2019-07-19T20:00:00Z
HTTP methods
Name Type Required Description
for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.
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.
Responses
Status code Response model Description
200 ApplicationDateRangeKpiResponse (p. 70)The request succeeded.
400 MessageBody (p. 71) The request contains a syntax
error (BadRequestException).
403 MessageBody (p. 71) The request was denied
because access to the
specified resource is forbidden (ForbiddenException).
404 MessageBody (p. 71) The request failed because the
specified resource was not found (NotFoundException).
405 MessageBody (p. 71) The request failed because
the method is not allowed for the specified resource (MethodNotAllowedException).
413 MessageBody (p. 71) The request failed because
the payload for the body of the request is too large
(RequestEntityTooLargeException).
429 MessageBody (p. 71) The request failed because
too many requests were sent during a certain amount of time (TooManyRequestsException).
500 MessageBody (p. 71) The request failed due to
an unknown internal server error, exception, or failure (InternalServerErrorException).
Schemas
OPTIONS
Retrieves information about the communication requirements and options that are available for the Application Metrics resource.
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.
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 email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.
Responses
Status code Response model Description
200 None The request succeeded.
Schemas
Response bodies
ApplicationDateRangeKpiResponse schema
{ "KpiName": "string", "KpiResult": { "Rows": [ {
"GroupedBys": [ {
"Key": "string", "Value": "string",
Properties
"Type": "string"
} ],
"Values": [ {
"Key": "string", "Value": "string", "Type": "string"
} ] } ]
}, "NextToken": "string", "ApplicationId": "string", "StartTime": "string", "EndTime": "string"
}
MessageBody schema
{ "RequestID": "string", "Message": "string"
}
Properties
ApplicationDateRangeKpiResponse
Provides the results of a query that retrieved the data for a standard metric that applies to an application, and provides information about that query.
KpiName
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.
Type: string Required: True
KpiResult
An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
Type: BaseKpiResult (p. 72) Required: True
NextToken
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.
Type: string
Properties
Required: False
ApplicationId
The unique identifier for the application that the metric applies to.
Type: string Required: True
StartTime
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.
Type: string Required: True
EndTime
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.
Type: string Required: True
BaseKpiResult
Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.
Rows
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.
Type: Array of type ResultRow (p. 73) Required: True
MessageBody
Provides information about an API request or response.
RequestID
The unique identifier for the request or response.
Type: string Required: False
Message
The message that's returned from the API.
Type: string Required: False
See also
ResultRow
Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.
GroupedBys
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.
Type: Array of type ResultRowValue (p. 73) Required: True
Values
An array of objects that provides pre-aggregated values for a standard metric that applies to an application, campaign, or journey.
Type: Array of type ResultRowValue (p. 73) Required: True
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.
Key
The friendly name of the metric whose value is specified by the Value property.
Type: string Required: True
Value
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).
Type: string Required: True
Type
The data type of the value specified by the Value property.
Type: string Required: True
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
Apps
GetApplicationDateRangeKpi
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
Apps
An app represents an Amazon Pinpoint application, also referred to as a project, in which you define an audience and you engage this audience with tailored messages. For example, you can use an application to send push notifications to users of your iOS or Android app, send email to newsletter subscribers, or send SMS messages to your customers' mobile phones.
After you create an application, you can define your audience by registering endpoints and defining segments. To engage your audience, define campaigns or write direct messages, and send your messages by using any supported channel, including channels for mobile push notifications, email, SMS, and voice.
You can then monitor application analytics by creating an event stream, which streams data for message deliveries and events that your app reports to Amazon Pinpoint. Analytics are also provided on the Amazon Pinpoint console.
You can use the Apps resource to create a new application or retrieve information about all of your existing applications. To delete an application, use the App (p. 61) resource and send a DELETE request to the /apps/application-id URI.
URI
/v1/apps
HTTP methods
GET
Operation ID: GetApps
Retrieves information about all the applications that are associated with your Amazon Pinpoint account.
Header parameters
Name Type Required Description
accept String False Indicates which content
types, expressed as MIME types, the client understands.
HTTP methods
Query parameters
Name Type Required Description
token String False The NextToken string
that specifies which page of results to return in a paginated response.
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.
Responses
Status code Response model Description
200 ApplicationsResponse (p. 77)The request succeeded.
400 MessageBody (p. 77) The request contains a syntax
error (BadRequestException).
403 MessageBody (p. 77) The request was denied
because access to the
specified resource is forbidden (ForbiddenException).
404 MessageBody (p. 77) The request failed because the
specified resource was not found (NotFoundException).
405 MessageBody (p. 77) The request failed because
the method is not allowed for the specified resource (MethodNotAllowedException).
413 MessageBody (p. 77) The request failed because
the payload for the body of the request is too large
(RequestEntityTooLargeException).
429 MessageBody (p. 77) The request failed because
too many requests were sent during a certain amount of time (TooManyRequestsException).
500 MessageBody (p. 77) The request failed due to
an unknown internal server error, exception, or failure (InternalServerErrorException).
HTTP methods
POST
Operation ID: CreateApp Creates an application.
Header parameters
Name Type Required Description
accept String False Indicates which content
types, expressed as MIME types, the client understands.
Responses
Status code Response model Description
201 ApplicationResponse (p. 77)The request succeeded and the specified resource was created.
400 MessageBody (p. 77) The request contains a syntax
error (BadRequestException).
403 MessageBody (p. 77) The request was denied
because access to the
specified resource is forbidden (ForbiddenException).
404 MessageBody (p. 77) The request failed because the
specified resource was not found (NotFoundException).
405 MessageBody (p. 77) The request failed because
the method is not allowed for the specified resource (MethodNotAllowedException).
413 MessageBody (p. 77) The request failed because
the payload for the body of the request is too large
(RequestEntityTooLargeException).
429 MessageBody (p. 77) The request failed because
too many requests were sent during a certain amount of time (TooManyRequestsException).
500 MessageBody (p. 77) 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 Apps resource.
Schemas
Responses
Status code Response model Description
200 None The request succeeded.
Schemas
Request bodies
POST schema
{
"Name": "string", "tags": {
} }
Response bodies
ApplicationsResponse schema
{ "NextToken": "string", "Item": [
{
"Name": "string", "Id": "string", "Arn": "string",
"CreationDate": "string", "tags": {
} } ]}
ApplicationResponse schema
{
"Name": "string", "Id": "string", "Arn": "string",
"CreationDate": "string", "tags": {
}}
MessageBody schema
{
"RequestID": "string", "Message": "string"
}
Properties
Properties
ApplicationResponse
Provides information about an application.
Name
The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
Type: string Required: True
Id
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
Type: string Required: True
Arn
The Amazon Resource Name (ARN) of the application.
Type: string Required: True
CreationDate
The creation date for the application.
Type: string Required: False
tags
A string-to-string map of key-value pairs that identifies the tags that are associated with the application.
Each tag consists of a required tag key and an associated tag value.
Type: object Required: False
ApplicationsResponse
Provides information about all of your applications.
NextToken
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
Type: string Required: False
See also
Item
An array of responses, one for each application that was returned.
Type: Array of type ApplicationResponse (p. 78) Required: False
CreateApplicationRequest
Specifies the display name of an application and the tags to associate with the application.
Name
The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
Type: string Required: True
tags
A string-to-string map of key-value pairs that defines the tags to associate with the application. Each tag consists of a required tag key and an associated tag value.
Type: object Required: False
MessageBody
Provides information about an API request or response.
RequestID
The unique identifier for the request or response.
Type: string Required: False
Message
The message that's returned from the API.
Type: string Required: False
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
GetApps
• AWS Command Line Interface
• AWS SDK for .NET
Attributes
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateApp
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
Attributes
An attribute is a characteristic of a user or an endpoint. It can be a standard attribute that Amazon Pinpoint defines or a custom attribute that you define. For example, you might create custom attributes that capture your users' contact information, their preferences, and the dates when they opted in or out of receiving specific types of messages from you.
The Attributes resource represents custom attributes that you've defined for users and endpoints that are associated with a specific application. You can use this resource to remove one or more custom attributes from all the endpoints that are associated with an application. For information about the attributes that you can use to define an endpoint, see the Endpoint (p. 298) resource.
Note: If you use the Attributes resource to remove a custom attribute, any existing values for the attribute persist in Amazon Pinpoint. This means that the attribute and its existing values continue to appear on the Amazon Pinpoint console and in export jobs. However, Amazon Pinpoint stops capturing new or changed values for a custom attribute after you remove the attribute.
To retrieve a list of custom attributes and attribute values for a specific user, use the User (p. 752) resource. To add or retrieve custom attributes and attribute values for endpoints, use the
Endpoints (p. 313) or Endpoint (p. 298) resource.
URI
/v1/apps/application-id/attributes/attribute-type
HTTP methods
PUT
Operation ID: RemoveAttributes
HTTP methods
Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application.
Path parameters
Name Type Required Description
attribute-type String True The type of attribute or attributes to remove. the date when an associated user opted in or out of receiving communications from you through a specific type of channel.
• endpoint-metric-attributes – Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart.
• endpoint-user-attributes – Custom attributes that describe users, such as first name, last name, and age.
application-id String True The unique identifier
for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
Header parameters
Name Type Required Description
accept String False Indicates which content
types, expressed as MIME types, the client understands.
HTTP methods
Responses
Status code Response model Description
200 AttributesResource (p. 83)The request succeeded.
400 MessageBody (p. 84) The request contains a syntax
error (BadRequestException).
403 MessageBody (p. 84) The request was denied
because access to the
specified resource is forbidden (ForbiddenException).
404 MessageBody (p. 84) The request failed because the
specified resource was not found (NotFoundException).
405 MessageBody (p. 84) The request failed because
the method is not allowed for the specified resource (MethodNotAllowedException).
413 MessageBody (p. 84) The request failed because
the payload for the body of the request is too large
(RequestEntityTooLargeException).
429 MessageBody (p. 84) The request failed because
too many requests were sent during a certain amount of time (TooManyRequestsException).
500 MessageBody (p. 84) 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 Attributes resource.
Path parameters
Name Type Required Description
attribute-type String True The type of attribute or attributes to remove.
Valid values are:
• endpoint-custom-attributes – Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving
Schemas
Name Type Required Description
communications from you through a specific type of channel.
• endpoint-metric-attributes – Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart.
• endpoint-user-attributes – Custom attributes that describe users, such as first name, last name, and age.
application-id String True The unique identifier
for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
Responses
Status code Response model Description
200 None The request succeeded.
Schemas
Request bodies
PUT schema
{ "Blacklist": [ "string"
]}
Response bodies
AttributesResource schema
{ "ApplicationId": "string",
Properties
"AttributeType": "string", "Attributes": [
"string"
] }
MessageBody schema
{ "RequestID": "string", "Message": "string"
}
Properties
AttributesResource
Provides information about the type and the names of attributes that were removed from all the endpoints that are associated with an application.
ApplicationId
The unique identifier for the application.
Type: string Required: True
AttributeType
The type of attribute or attributes that were removed from the endpoints. Valid values are:
• endpoint-custom-attributes – Custom attributes that describe endpoints.
• endpoint-metric-attributes – Custom metrics that your app reports to Amazon Pinpoint for endpoints.
• endpoint-user-attributes – Custom attributes that describe users.
Type: string Required: True
Attributes
An array that specifies the names of the remaining attributes after any attributes were removed from the endpoints.
Type: Array of type string Required: False
MessageBody
Provides information about an API request or response.
See also
RequestID
The unique identifier for the request or response.
Type: string Required: False
Message
The message that's returned from the API.
Type: string Required: False
UpdateAttributesRequest
Specifies one or more attributes to remove from all the endpoints that are associated with an application.
Blacklist
An array of the attributes to remove from all the endpoints that are associated with the application. The array can specify the complete, exact name of each attribute to remove or it can specify a glob pattern that an attribute name must match in order for the attribute to be removed.
Type: Array of type string Required: False
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
RemoveAttributes
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3