aws-pinpoint-analytics
v0.8.1
Published
AWS Pinpoint integration for 'analytics' module
Downloads
49
Maintainers
Readme
AWS Pinpoint Plugin for analytics
Integration with AWS Pinpoint for analytics
Amazon Pinpoint is a flexible and scalable outbound and inbound marketing communications service. You can connect with customers over channels like email, SMS, push, or voice.
This package weighs in at 12.8kb
gzipped.
- Installation
- How to use
- Platforms Supported
- Browser usage
- Server-side usage
- Additional examples
- Authenticating
Installation
Install analytics
and @analytics/aws-pinpoint
packages
npm install analytics
npm install @analytics/aws-pinpoint
How to use
The @analytics/aws-pinpoint
package works in the browser and server-side in Node.js. To use, install the package, include in your project and initialize the plugin with analytics.
Below is an example of how to use the browser plugin.
import Analytics from 'analytics'
import awsPinpointPlugin from '@analytics/aws-pinpoint'
const analytics = Analytics({
app: 'awesome-app',
plugins: [
awsPinpointPlugin({
pinpointAppId: '938bebb1ae954e123133213160f2b3be4',
getCredentials: () => Auth.currentCredentials()
})
]
})
/* Track a page view */
analytics.page()
/* Track a custom event */
analytics.track('cartCheckout', {
item: 'pink socks',
price: 20
})
/* Identify a visitor */
analytics.identify('user-id-xyz', {
firstName: 'bill',
lastName: 'murray'
})
After initializing analytics
with the awsPinpointPlugin
plugin, data will be sent into AWSPinpoint whenever analytics.track, or analytics.identify are called.
See additional implementation examples for more details on using in your project.
Platforms Supported
The @analytics/aws-pinpoint
package works in the browser and server-side in Node.js
Browser usage
The AWSPinpoint client side browser plugin works with these analytic api methods:
- analytics.page - Sends page views into AWSPinpoint
- analytics.track - Track custom events and send to AWSPinpoint
- analytics.identify - Identify visitors and send details to AWSPinpoint
- analytics.reset - Reset browser storage cookies & localstorage for AWSPinpoint values
Browser API
import Analytics from 'analytics'
import awsPinpointPlugin from '@analytics/aws-pinpoint'
const analytics = Analytics({
app: 'awesome-app',
plugins: [
awsPinpointPlugin({
pinpointAppId: '938bebb1ae954e123133213160f2b3be4',
getCredentials: () => Auth.currentCredentials()
})
]
})
Configuration options for browser
| Option | description |
|:---------------------------|:-----------|
| pinpointAppId
required - string| AWS Pinpoint app Id for client side tracking |
| getCredentials
required - function| Async function to get AWS Cognito creds |
| pinpointRegion
optional - string| AWS Pinpoint region. Defaults to us-east-1 |
| appTitle
optional - string| The title of the app that's recording the event. |
| appPackageName
optional - string| The name of the app package, such as com.example.my_app. |
| appVersionCode
optional - string| The version number of the app, such as 3.2.0 |
| fips
optional - string| Use the AWS FIPS service endpoint for Pinpoint |
| disableAnonymousTraffic
optional - boolean| Disable anonymous events from firing |
Server-side usage
The AWSPinpoint server-side node.js plugin works with these analytic api methods:
- analytics.track - Track custom events and send to AWSPinpoint
- analytics.identify - Identify visitors and send details to AWSPinpoint
Server-side API
import Analytics from 'analytics'
import awsPinpointPlugin from '@analytics/aws-pinpoint'
const analytics = Analytics({
app: 'awesome-app',
plugins: [
awsPinpointPlugin({
pinpointAppId: '938bebb1ae954e123133213160f2b3be4',
getCredentials: () => Auth.currentCredentials()
})
]
})
Configuration options for server-side
| Option | description |
|:---------------------------|:-----------|
| pinpointAppId
required - string| AWS Pinpoint app Id for client side tracking |
| getCredentials
required - function| Async function to get AWS Cognito creds |
| pinpointRegion
optional - string| AWS Pinpoint region. Defaults to us-east-1 |
| appTitle
optional - string| The title of the app that's recording the event. |
| appPackageName
optional - string| The name of the app package, such as com.example.my_app. |
| appVersionCode
optional - string| The version number of the app, such as 3.2.0 |
| fips
optional - string| Use the AWS FIPS service endpoint for Pinpoint |
| disableAnonymousTraffic
optional - boolean| Disable anonymous events from firing |
Additional examples
Below are additional implementation examples.
import Analytics from 'analytics'
import awsPinpointPlugin from '@analytics/aws-pinpoint'
const analytics = Analytics({
app: 'awesome-app',
plugins: [
awsPinpointPlugin({
pinpointAppId: '938bebb1ae954e123133213160f2b3be4',
getCredentials: () => Auth.currentCredentials()
})
// ...other plugins
]
})
/* Track a custom event */
analytics.track('cartCheckout', {
item: 'pink socks',
price: 20
})
/* Identify a visitor */
analytics.identify('user-id-xyz', {
firstName: 'bill',
lastName: 'murray'
})
If using node, you will want to import the .default
const analyticsLib = require('analytics').default
const awsPinpointPlugin = require('@analytics/aws-pinpoint').default
const analytics = analyticsLib({
app: 'my-app-name',
plugins: [
awsPinpointPlugin({
pinpointAppId: '938bebb1ae954e123133213160f2b3be4',
getCredentials: () => Auth.currentCredentials()
})
]
})
/* Track a custom event */
analytics.track('cartCheckout', {
item: 'pink socks',
price: 20
})
/* Identify a visitor */
analytics.identify('user-id-xyz', {
firstName: 'bill',
lastName: 'murray'
})
Below is an example of importing via the unpkg CDN. Please note this will pull in the latest version of the package.
<!DOCTYPE html>
<html>
<head>
<title>Using @analytics/aws-pinpoint in HTML</title>
<script src="https://unpkg.com/analytics/dist/analytics.min.js"></script>
<script src="https://unpkg.com/@analytics/aws-pinpoint/dist/@analytics/aws-pinpoint.min.js"></script>
<script type="text/javascript">
/* Initialize analytics */
var Analytics = _analytics.init({
app: 'my-app-name',
plugins: [
analyticsAWSPinpoint({
pinpointAppId: '938bebb1ae954e123133213160f2b3be4',
getCredentials: () => Auth.currentCredentials()
})
]
})
/* Track a page view */
analytics.page()
/* Track a custom event */
analytics.track('cartCheckout', {
item: 'pink socks',
price: 20
})
/* Identify a visitor */
analytics.identify('user-id-xyz', {
firstName: 'bill',
lastName: 'murray'
})
</script>
</head>
<body>
....
</body>
</html>
Using @analytics/aws-pinpoint
in ESM modules.
<!DOCTYPE html>
<html>
<head>
<title>Using @analytics/aws-pinpoint in HTML via ESModules</title>
<script>
// Polyfill process.
// **Note**: Because `import`s are hoisted, we need a separate, prior <script> block.
window.process = window.process || { env: { NODE_ENV: 'production' } }
</script>
<script type="module">
import analytics from 'https://unpkg.com/analytics/lib/analytics.browser.es.js?module'
import analyticsAWSPinpoint from 'https://unpkg.com/@analytics/aws-pinpoint/lib/analytics-plugin-aws-pinpoint.browser.es.js?module'
/* Initialize analytics */
const Analytics = analytics({
app: 'analytics-html-demo',
debug: true,
plugins: [
analyticsAWSPinpoint({
pinpointAppId: '938bebb1ae954e123133213160f2b3be4',
getCredentials: () => Auth.currentCredentials()
})
// ... add any other third party analytics plugins
]
})
/* Track a page view */
analytics.page()
/* Track a custom event */
analytics.track('cartCheckout', {
item: 'pink socks',
price: 20
})
/* Identify a visitor */
analytics.identify('user-id-xyz', {
firstName: 'bill',
lastName: 'murray'
})
</script>
</head>
<body>
....
</body>
</html>
Authenticating
Pinpoint requires a valid identity to make calls to the service.
To do this you will need to use the AWS SDK, AWS Amplify, tiny-cognito etc to vend AWS creds for that visitors to be allowed to call pinpoint
The getCredentials
must be provided and return an object that returns accessKeyId
, secretAccessKey
, sessionToken
that have access to your AWS pinpoint instance.
{
accessKeyId: 'xyz',
secretAccessKey: 'xyz',
sessionToken: 'xyz'
}
Here is an example using tiny-cognito
import Analytics from 'analytics'
import cognitoAuth from 'tiny-cognito'
import awsPinpointPlugin from '@analytics/aws-pinpoint'
// Identity pool ID that allows for unauthenticated access.
const poolId = 'us-east-1:11111111-22222-222222-44444'
const region = 'us-east-1'
function getCredentials() {
return cognitoAuth({
COGNITO_REGION: region,
IDENTITY_POOL_ID: poolId
})
}
const analytics = Analytics({
app: 'awesome-app',
plugins: [
awsPinpointPlugin({
pinpointAppId: '123456789',
getCredentials: getCredentials
})
]
})
Here is an example using @aws-amplify/auth
import Analytics from 'analytics'
import AmplifyAuth from '@aws-amplify/auth'
import awsPinpointPlugin from '@analytics/aws-pinpoint'
const analytics = Analytics({
app: 'awesome-app',
plugins: [
awsPinpointPlugin({
pinpointAppId: '123456789',
// Get credentials from amplify
getCredentials: async () => {
const creds = await AmplifyAuth.currentCredentials()
return creds
},
})
]
})