Report Amazon Pinpoint events in your application
In your mobile or web application, you can use AWS Mobile SDKs or the Amazon Pinpoint events API to report usage data, or events, to Amazon Pinpoint. You can report events to capture information such as session times, users' purchasing behavior, sign-in attempts, or any custom event type that you need.
After your application reports events, you can view analytics in the Amazon Pinpoint console. The charts on the Analytics page provide metrics for many aspects of user behavior. For more information, see Chart reference for Amazon Pinpoint analytics in the Amazon Pinpoint User Guide.
To analyze and store your event data outside of Amazon Pinpoint, you can configure Amazon Pinpoint to stream the data to Amazon Kinesis. For more information, see Stream app event data through Kinesis and Firehose using Amazon Pinpoint.
By using the AWS Mobile SDKs and the AWS Amplify JavaScript libraries, you can call the Amazon Pinpoint API to report the following types of events:
- Session events
-
Indicate when and how often users open and close your app.
After your application reports session events, use the Analytics page in the Amazon Pinpoint console to view charts for Sessions, Daily active endpoints, 7-day retention rate, and more.
- Custom events
-
Are nonstandard events that you define by assigning a custom event type. You can add custom attributes and metrics to a custom event.
On the Analytics page in the console, the Events tab displays metrics for all custom events that are reported by your app.
- Monetization events
-
Report the revenue that's generated by your application and the number of items that are purchased by users.
On the Analytics page, the Revenue tab displays charts for Revenue, Paying users, Units sold, and more.
- Authentication events
-
Indicate how frequently users authenticate with your application.
On the Analytics page, the Users tab displays charts for Sign-ins, Sign-ups, and Authentication failures.
Before you begin
If you haven't already, do the following:
-
Integrate your app with AWS Amplify. See Connect your frontend application to Amazon Pinpoint using AWS Amplify.
-
Update your application to register endpoints. See Register Amazon Pinpoint endpoints in your application.
Report events with the AWS mobile SDKs for Android or iOS
You can enable a mobile app to report events to Amazon Pinpoint by using the AWS Mobile SDKs for iOS and Android.
For more information about updating your app to record and submit events to Amazon Pinpoint, see the following pages in the AWS Amplify documentation:
Report events with the AWS Amplify JavaScript library
You can enable JavaScript and React Native apps to report application usage events to
Amazon Pinpoint by using the AWS Amplify JavaScript library. For more information about updating
your app to submit events to Amazon Pinpoint, see Analytics
Report events with the Amazon Pinpoint API
You can use the Amazon Pinpoint API or an AWS SDK to submit events to Amazon Pinpoint in bulk. For more information, see Events in the Amazon Pinpoint API Reference.
Next steps
After you update your app to report events, it sends usage data to Amazon Pinpoint. You can view this data in the console and stream it to Amazon Kinesis. You can also update your app to handle the push notifications that you send with Amazon Pinpoint. For more information, see the following topics in the AWS End User Messaging Push User Guide.
