Amplitude

This library exports the amplitude plugin for the analytics package.

This analytics plugin will load Amplitude integration into your application.

For more information see the docs.

Installation

``bash
npm install analytics
npm install @analytics/amplitude
`

How to use

The @analytics/amplitude 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.

`js
import Analytics from 'analytics'
import amplitudePlugin from '@analytics/amplitude'

const analytics = Analytics({
app: 'awesome-app',
plugins: [
amplitudePlugin({
apiKey: 'token',
// See options at https://bit.ly/3dRdZnE
options: {
trackingOptions: {
ip_address: false
}
}
})
]
})

/ 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 amplitudePlugin plugin, data will be sent into Amplitude 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/amplitude package works in the browser

Browser usage

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

- analytics.page - Sends page views into Amplitude
- analytics.track - Track custom events and send to Amplitude
- analytics.identify - Identify visitors and send details to Amplitude

$3

`js
import Analytics from 'analytics'
import amplitudePlugin from '@analytics/amplitude'

const analytics = Analytics({
app: 'awesome-app',
plugins: [
amplitudePlugin({
apiKey: 'token',
// See options at https://bit.ly/3dRdZnE
options: {
trackingOptions: {
ip_address: false
}
}
})
]
})

`

$3

| Option | description |
|:---------------------------|:-----------|
| apiKey
required - string| Amplitude project API key |
| options
required - object| Amplitude SDK options |
| initialSessionId
required - string| Set initial session ID |

Additional examples

Below are additional implementation examples.

Setting Custom Session Ids

You can set a session id like so

`js
import Analytics from 'analytics'
import amplitudePlugin from '@analytics/amplitude'

const analytics = Analytics({
app: 'awesome-app',
plugins: [
amplitudePlugin({
apiKey: 'token',
})
]
})

// Run custom method https://getanalytics.io/plugins/writing-plugins/#adding-custom-methods
analytics.plugins['amplitude'].setSessionId('your-id')
`

Or via the initialSessionId config value

`js
import Analytics from 'analytics'
import amplitudePlugin from '@analytics/amplitude'

const analytics = Analytics({
app: 'awesome-app',
plugins: [
amplitudePlugin({
apiKey: 'token',
initialSessionId: 'xyz-123'
})
]
})
``