Getting Started With mPulse SDK for Native Apps

Beacons are packets of information that track metrics related to performance. The mPulse SDK allows you use to send beacons from any Android/iOS application to mPulse.

The mPulse SDK lets you automatically instrument all network requests, send Custom Metric and Custom Timer beacons to mPulse. For each beacon, you can set the View Group, A/B test, and Custom Dimensions.

The mPulse SDK automatically monitors all network activity performed by the application and its libraries. Each network request can be monitored individually, and its performance data can be sent on a beacon.

The mPulse SDK also allows you to monitor Actions, which are distinct user interactions. This has the following advantages over the default network monitoring. 

  • Actions can be started and stopped either programmatically or automatically by the SDK, once all network activity has quieted down. All network requests during the Action are included in the Action beacon’s Waterfall. 
  • Actions are more efficient because they combine all the information into one beacon. This is not only cheaper but easier to understand. 

The primary features one could opt for in a native app with mPulse SDK are listed in detail below. 

Feature Description
Custom Metrics Custom Metrics are user-defined counts that refer to a business goal, or a Key Performance Indicator (KPI) such as revenue, conversion, orders per minute, widgets sold, etc. The value or meaning of a Custom Metric is defined by the App Administrator.

You can programmatically increment a Custom Metric using the SDK.

Custom Metrics must be defined in the App dialog through Akamai Control Center before use.

Custom Timers A Custom Timer can be based on any measurable user-defined duration.

You can programmatically send the value of a Custom Timer using the SDK.

Custom Timers must be defined in the App dialog before use.

View Groups A View Group (also known as a Page Group in a web app) allows for measurement across views that belong together. Grouping views in this way helps you capture and summarize the performance characteristics across the entire group.

For mobile apps, Launch may make up one View Group, while the Login view may make up a second, and Product views the third group. Search Results and Checkout views may also have their groups.

You can programmatically set the View Group using the SDK.

Custom Dimensions In addition to the out-of-the-box dimensions already provided within mPulse, App Admins can define additional Custom Dimensions for the given app. For example, a Custom Dimension to track Premium Users versus Free Users.

You can programmatically set a Custom Dimension using the SDK.

Custom Dimensions must be defined in the App dialog before use.

A/B Test You may get, set, and reset the A/B Test. Once set, the A/B Test will be associated with every subsequent beacon.
App Actions (Waterfall Charts) Actions can be started at any time by calling startAction(), and can be stopped by either calling stopAction(), or, by having the SDK automatically stop the Action once all network activity has finished.

The two Action modes are called Wait mode and Timeout mode. All network requests during the Action will be included on the Action beacon’s Waterfall.

There can only be a single Action ongoing at a time.

Before using the mPulse SDK, you will need to have a mPulse app and an associated API Key. For information on how to set up the mPulse app and the API Key, read instructions shared below.

Activating mPulse from Marketplace in Akamai Control Center

Note: This section is not applicable to existing users of mPulse and is meant to help first-time users activate the product. Please feel free to skip if you are an existing mPulse user.


  1. Log in to the Akamai Control Center at

  2. In the top-right corner, click Marketplace



  3. From the list, choose Digital Performance Management

    Marketplace Start


  4. Click the tile for mPulse to activate mPulse 30-day free trial. 

    mPulse 30 day trial


  5. In the Trial section, click the Start trial button to proceed. 

    Start Trial


  6. Select a contract under which you would like to activate mPulse. If you only have one contract under your account then it will be selected by default.

  7. Accepting the terms & conditions and click Start Trial



  8. Congratulations! You should receive an email shortly confirming mPulse trial activation for your Akamai account.

Creating an App Policy and Generating a License Key for mPulse

  1. Start by navigating to the Akamai Control Center at

  2. Click on the hamburger menu located at the top left corner. 

    Akamai Control Center Menu


  3. Type “mPulse” in the search bar and click on mPulse real user monitoring from the results and you will be routed to the mPulse portal. 



  4. Click New App. 

    New App


  5. Select your project type and fill in your app name. Upon completion click Next

    Native App Selection


  6. Follow instructions and click next

    Configure your App


  7. Follow the instructions, and make sure to copy the license key. You'll need this key in the future. Click Next.

    • (The methods to initialize mPulse SDK with API key has changed for SDK version 20.32 and above. Hence, ignore the initialization steps mentioned here. Copy and securely store the license key for future reference).

      License key page


  8. Congratulations! You created your app configuration, and the portal is now waiting to receive traffic/beacons from the app. 

    Finish Screen


  9. You can either wait for beacons to complete the rest of the setup or click on Advanced and then Exit the screen to get back to integration.

Once your app has been configured in mPulse, you can start using the mPulse SDK with the API Key. Follow these links to get more instructions on how to configure individual features for mPulse SDK on Android and iOS.


For more information, visit the Akamai mPulse home page.