amplitude-client-node
A simple wrapper around Amplitude's Groups and HTTP (v2) APIs.
For legacy v1 HTTP API, use v0.2.0
.
Features:
- automatic, configurable retry with generated
insert_id
- TypeScript support
- No dependencies
- event tracking (
/2/httpapi
) - group identification (
/groupidentify
) - user identification (
/identify
) - there are tests
- requires Node v8 or higher
Installation
npm install amplitude-client-node
Usage
const amplitude = ;// for typescript:// import * as amplitude from 'amplitude-client-node'; const client = 'api key' // all keys are optional maxRetries: 3 timeoutMs: 2500 enabled: true // disable sending of events, useful in dev endpoint: 'https://api.amplitude.com' appVersion: '1.2.3' // will set app_version in all outgoing events setTime: true // will set time to Date.now() in all outgoing events { console; }; const myEvent = event_type: 'user register' user_id: '12345' event_properties: source: 'marketing site' whatever: 'you want' groups: teamId: '67890' ; client ;
Successful calls return an AmplitudeResponse
object:
If all retries fail, or a non-retryable status code is returned from the Amplitude
API, then an error object is thrown that has a response
property that is set to
the AmplitudeResponse
object defined above.