Events

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

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

The request was accepted for processing. Processing may not be complete.

The request contains a syntax error (BadRequestException).

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

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

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

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

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

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

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

The request succeeded.

string

The version of the app that's associated with the endpoint. Can contain a maximum of 50 characters.

string

An identifier that represents the endpoint's language, in IETF BCP 47 format. This identifier typically consists of an ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value. For example, the locale code for United States English is en_US.

In some cases, an ISO 3166-1 numeric-3 value is used instead of an ISO 3166-1 alpha-2 value. For example, the locale code for Latin American Spanish is es_419.

In other cases, the ISO 639-1 alpha-2 is replaced with a three-letter code. For example, the locale code for Hawaiian is haw_US.

string

The manufacturer of the endpoint device, such as Apple or Samsung. Can contain a maximum of 50 characters.

string

The model name or number of the endpoint device, such as iPhone or SM-G900F. Can contain a maximum of 100 characters.

string

The model version of the endpoint device. Can contain a maximum of 50 characters.

string

The platform of the endpoint device, such as iOS. Can contain a maximum of 50 characters.

string

The version of the platform for the endpoint device. Can contain a maximum of 50 characters.

string

The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.

string

The custom message that's returned in the response as a result of processing the endpoint data.

integer

The status code that's returned in the response as a result of processing the endpoint data.

string

The name of the city where the endpoint is located. Can contain a maximum of 75 characters.

string

A code that represents the country or region where the endpoint is located. Must be in ISO 3166-1 Alpha-2 or Alpha-3 format. For example, for the United States, you can use US or USA.

number

The latitude coordinate of the endpoint location, rounded to one decimal place. Must be between -90 and 90. If you specify a latitude, you must also specify a longitude.

number

The longitude coordinate of the endpoint location, rounded to one decimal place. Must be between -180 and 180. If you specify a longitude, you must also specify a latitude.

string

The postal or ZIP code for the area where the endpoint is located.

string

The name of the region where the endpoint is located. This value is typically a first-level subdivision a country, such as a state, province, prefecture, administrative region, district, or department. Can contain a maximum of 75 characters.

object

One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.

An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.

string

The unique identifier for the user. The identifier can't contain $, { or }.

string

The package name of the app that's recording the event.

string

The title of the app that's recording the event.

string

The version number of the app that's recording the event.

object

One or more custom attributes that are associated with the event.

string

The version of the SDK that's running on the client device.

string

The name of the event.

object

One or more custom metrics that are associated with the event.

string

The name of the SDK that's being used to record the event.

Session

Information about the session in which the event occurred.

string

The date and time, in ISO 8601 format, when the event occurred.

string

A custom message that's returned in the response as a result of processing the event.

integer

The status code that's returned in the response as a result of processing the event. Possible values are: 202, for events that were accepted; and, 400, for events that weren't valid.

PublicEndpoint

A set of properties and attributes that are associated with the endpoint.

object

A set of properties that are associated with the event.

object

The batch of events to process. For each item in a batch, the endpoint ID acts as a key that has an EventsBatch object as its value. The identifier can't contain $, { or }.

object

A map that contains a multipart response for each endpoint. For each item in this object, the endpoint ID is the key and the item response is the value. If no item response exists, the value can also be one of the following: 202, the request was processed successfully; or 400, the payload wasn't valid or required fields were missing.

EndpointItemResponse

The response that was received after the endpoint data was accepted.

object

A multipart response object that contains a key and a value for each event in the request. In each object, the event ID is the key and an EventItemResponse object is the value.

string

The message that's returned from the API.

string

The unique identifier for the request or response.

string

The unique identifier for the recipient, such as a device token, email address, or mobile phone number.

object

One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.

string

Values: PUSH | GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | VOICE | EMAIL | BAIDU | CUSTOM | IN_APP

The channel that's used when sending messages or push notifications to the endpoint.

EndpointDemographic

The demographic information for the endpoint, such as the time zone and platform.

string

The date and time, in ISO 8601 format, when the endpoint was last updated.

string

Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

EndpointLocation

The geographic information for the endpoint.

object

One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

string

Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

string

A unique identifier that's generated each time the endpoint is updated.

EndpointUser

One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

integer

The duration of the session, in milliseconds. Duration is required if a value is provided for the StopTimestamp.

string

The unique identifier for the session.

string

The date and time when the session began.

string

The date and time when the session ended.