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.

View the docs.

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. 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.page, 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

Browser usage

The AWSPinpoint client side browser plugin works with these analytic api methods:

• analytics.page - Sends page views into AWSPinpoint
• analytics.reset - Reset browser storage cookies & localstorage for AWSPinpoint values
• analytics.track - Track custom events and send to AWSPinpoint
• analytics.identify - Identify visitors and send details to AWSPinpoint

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

Additional examples

Below are additional implementation examples.

  
    <title>Using @analytics/aws-pinpoint in HTML</title>
    
    
    
  
  
    ....
  

  
    <title>Using @analytics/aws-pinpoint in HTML via ESModules</title>
    
    
  
  
    ....