API Reference

​

new Analytics(settings)

Create an analytics instance. Returns: Analytics

---

​

analytics.identify(params, callback?)

Identify a user. Returns void. Params: userId?, anonymousId?, traits?, context?, timestamp?, integrations?, messageId? At least one of userId or anonymousId is required.

---

​

analytics.track(params, callback?)

Track an event. Returns void. Params: event (required), plus identity fields, properties?, context?, timestamp?, integrations?, messageId?

---

​

analytics.page(params, callback?)

Track a page view. Returns void. Params: identity fields, category?, name?, properties?, context?, timestamp?, integrations?, messageId?

---

​

analytics.screen(params, callback?)

Track a screen view. Same shape as page(). Returns void.

---

​

analytics.group(params, callback?)

Associate a user with a group. Returns void. Params: groupId (required), identity fields, traits?, context?, timestamp?, integrations?, messageId?

---

​

analytics.alias(params, callback?)

Merge identities. Returns void. Params: userId (required), previousId (required), context?, timestamp?, integrations?, messageId?

---

​

analytics.closeAndFlush(options?)

Flush queued events and stop accepting new ones. Returns Promise<void>. Options: timeout? (ms). Default timeout is approximately flushInterval * 1.25.

---

​

analytics.register(…plugins) / analytics.deregister(…names)

Register or remove plugins. Both return Promise<void>.

---

​

analytics.on(event, listener)

Subscribe to emitter events such as error, http_request, and drained.