Amplitude integration for 'analytics' module
npm install @analytics/amplitudeThis 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.
Click to expand
- Installation
- How to use
- Platforms Supported
- Browser usage
- Browser API
- Configuration options for browser
- Additional examples
- Setting Custom Session Ids
``bash`
npm install analytics
npm install @analytics/amplitude
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.
The @analytics/amplitude package works in the browser
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
`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
}
}
})
]
})
`
| Option | description |
|:---------------------------|:-----------|
| apiKey options
required - string| Amplitude project API key |
| initialSessionId
required - object| Amplitude SDK options |
|
required - string| Set initial session ID |
Below are additional implementation examples.
Using in HTML
Below is an example of importing via the unpkg CDN. Please note this will pull in the latest version of the package.
`html
....
`
Using in HTML via ES Modules
Using @analytics/amplitude in ESM modules.
`html
....
`
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'
})
]
})
``