react-amplitude
React Amplitude Analytics
This is a JavaScript module that can be used to include Amplitude Analytics tracking code in a website or app that uses React for its front-end codebase.
Feel free to file issues, ideas and pull requests against this repo.
Installation
With yarn:
yarn add react-amplitude
With npm:
npm install react-amplitude --save
Usage
Initializing:
;; ...;Amplitude;... document;
API
Amplitude.init(apiKey, userId, config, callback)
Must be initialized using this function before any of the other tracking functions will record any data.
Example
Amplitude;
Value | Notes |
---|---|
apiKey | String . Required. |
userId | String . Optional. |
config | Object . Optional. |
callback | Function . Optional. |
Amplitude.logEvent(eventName, eventProperties, callback)
Log an event to Amplitude.
Example
Amplitude;
Value | Notes |
---|---|
eventName | String . Required. |
eventProperties | Object . Optional. |
callback | Function . Optional. |
Amplitude.logEventWithTimestamp(eventName, eventProperties, timestamp, callback)
Log an event to Amplitude.
Example
Amplitude;
Value | Notes |
---|---|
eventName | String . Required. |
eventProperties | Object . Optional. |
timestamp | Number . Optional. |
callback | Function . Optional. |
Amplitude.resetUserId()
Remove user tracking (e.g. on logging out).
Example
Amplitude;
Amplitude.setUserId(userId)
Track users through a unique user id.
Example
Amplitude;
Value | Notes |
---|---|
userId | String . Required. |
Amplitude.setUserProperties(userProps)
Track user properties
Example
Amplitude;
Value | Notes |
---|---|
userProps | object . Required. |
Amplitude.clearUserProperties()
Clear user properties (careful, this is irreversible!)
Example
Amplitude;
Amplitude.getSessionId()
Returns current session id
Example
Amplitude;
Amplitude.identify(idObj, callback)
Send an identify call containing user property operations to Amplitude servers
Example
Amplitude;
Value | Notes |
---|---|
idObj | object . Required. |
callback | Function . Optional. |
Amplitude.isNewSession()
Returns if a new session was created at init
Example
Amplitude;
Development
git clone https://github.com/rorygarand/react-amplitude.gityarn installnpm run build