You can use the mPulse API service to view real-time analytics and user measurement beacons for web sites to observe how real users interact within your sites.

The mPulse API service consists of six major components:

  • Tokens. The mPulse Tokens API is used to authenticate login credentials, and provides a security token that must be included with every other API request.

  • Objects. The mPulse Objects API is used to create, read, update, and delete Repository objects.

  • Alerts. The mPulse Alerts API allows you to trigger and clear alerts from an external application. Although you can send your customized content at any time, there are rate limits. The Alert component requires configuring an alert in the UI for external invocation. For details, see How to Configure Webhook for an Alert. For information, see How to Configure Webhook for an Alert.

  • Annotations. The mPulse Annotations API allows you to create, list, fetch, and update annotations on objects like charts or graphs. All operations use an X-Auth-Token name/value in the request header. See Generate a token.

  • Queries. The mPulse Query API is a unified Representational State Transfer (REST) API that allows mPulse customers to fetch aggregate data and receive a JSON response with mPulse data. Data sets, navigation timing, custom timers, and metrics are supported.
    See mPulse Queries for more information about this component of the mPulse API.

  • Beacons. The mPulse Beacons API is a programmatic interface that you can use to send beacons from any web application to mPulse. This includes a Representational State Transfer (REST) interface that can be used by web applications written in any language and running on any platform. In addition, there is an mPulse Beacon API reference library for JavaScript.
    See mPulse Beacons for more information about this component of the mPulse API.