Star us on GitHub
Star
Menu

Amplitude Integration

We've made it easy to use Amplitude with Highlight. When you initialize Highlight, you can set your Amplitude API Key.

H.init('<YOUR_PROJECT_ID>', { integrations: { amplitude: { apiKey: '<AMPLITUDE_API_KEY>', }, }, })
Copy

API

logEvent()

Calling H.track() will forward the data to Amplitude's logEvent().

H.track('signup_button_clicked', { firstTime: true, impressions: 10, }) // The Highlight track call is equivalent to this logEvent call amplitudeClient.logEvent('signup_button_clicked', { firstTime: true, impressions: 10, // This property is added by Highlight. This shows you the session where this event happened. highlightSessionURL: 'https://app.highlight.io/sessions/123', })
Copy

setUserId() and identify()

Calling H.identify() will forward the data to Amplitude's setUserId() and identify().

H.identify('eliza@corp.com', { planType: 'premium', verified: false, }) // The Highlight identify call is equivalent to setUserId and identify. amplitudeClient.setUserId('eliza@corp.com') amplitudeClient.identify(new amplitude.Identify().set('planType', 'premium').set('verified', false))
Copy

If you want to disable this behavior, you can set enabled: false for the integration:

H.init('<YOUR_PROJECT_ID>', { integrations: { amplitude: { enabled: false, }, }, })
Copy