The mPulse JavaScript API (mpulse.js) allows you to send beacons from JavaScript to Akamai mPulse via the mPulse Beacon API.
mpulse.js is available from the Akamai/mpulse.js Github repository.
The un-minified version is available at :
dist/mpulse.js
There is a minified version available at:
dist/mpulse.min.js
Please include the script in your web app prior to its use:
<script src="mpulse.js"></script>
dist/ instead of src/, unless the CryptoJS libraries are already loaded
mpulse.js is also available via bower. You can install using:
bower install mpulse
Once mpulse.js is loaded, there is a global mPulse object available on window.mPulse.
mpulse.js also registers itself as a RequireJS module.
For information on how to obtain the REST API Secret Key, go to [mPulse setup] (https://community.akamai.com/docs/DOC-8511).
To start working with the API, you first need to configure it with your API key and REST API Secret Key:
var mPulseApp = mPulse.init("api-key", "rest-api-secret-key");
After init() has been called, you can either interact with it via the returned object or via the same methods on the core mPulse object:
mPulseApp.sendTimer("My Timer", 100);
// or
window.mPulse.sendTimer("My Timer", 100);
For mPulse to work on Cordova, you need to make the following changes in your application:
In your index.html you need to extend the Content-Security-Policy to support HTTP requests to the mPulse servers:
<meta http-equiv="Content-Security-Policy" content="img-src https://*.akstat.io; connect-src https://*.akstat.io https://*.go-mpulse.net;">
Explanation of individual rules:
img-src https://*.akstat.io: Boomerang will send GET requests with beacon data to a host in the akstat.io domain using dynamically created IMG elements over HTTPS.
connect-src https://*.akstat.io: Boomerang will send POST requests with beacon data using XHR or the sendBeacon API to a host in the akstat.io domain over HTTPS.
connect-src https://*.go-mpulse.net: Boomerang will fetch it's configuration from *.go-mpulse.net using XHR over HTTPS.
Include mpulse.js in your applications body as a script:
<script type="text/javascript" src="js/mpulse.min.js"></script>
src to the place where your project's setup installed the bower build of mpulse.js. For more information, refer to the Quick-Start Guide.
In your application initialization, you need to add the following lines:
// The mpulse.js instance to use later on
var mPulseInstance = null;
// Your application specific API credentials
var APIKEY = "YOUR API KEY";
var REST_API_SECRET = "YOUR REST API SECRET";
// The start of your application
var app = {
// Your application initialization
initialize: function() {
mPulseInstance = mPulse.init(APIKEY, REST_API_SECRET);
// The rest of your application initialization
this.bindEvents();
},
// Bind your application events
bindEvents: function() {
document.addEventListener('deviceready', this.onDeviceReady, false);
},
onDeviceReady: function() {
// example mPulse.js instance interaction
mPulseInstance.sendTimer("deviceReady", deviceReadyTime - deviceInitTime);
},
};
app.initialize();
mPulse.init(apiKey, restApiSecretKey, options)apiKey (String) mPulse API keyrestApiSecretKey (String) mPulse REST API Secret Keyoptions (Object) Additional optionsA reference to the mPulse app.
var mPulseApp = mPulse.init("api-key", "rest-api-secret-key");
mPulse.startTimer(name)Starts a timer with the specified name. Use stopTimer(id) to stop and send the timer.
name (String) Custom Timer nameAn id (string) that you can use with stopTimer(id).
var timerId = mPulse.startTimer("My Timer");
// ... do stuff ...
mPulse.stopTimer(timerId);
stopTimer(id)Stops a timer previously started via startTimer().
id (String) Timer ID from startTimer()The number of milliseconds that the timer ran.
var timerId = mPulse.startTimer("My Timer");
// ... do stuff ...
mPulse.stopTimer(timerId);
sendTimer(name, value)Sends a timer with the specified name and value.
name (String) Custom Timer namevalue (Number) Time (milliseconds)The number of milliseconds that the timer ran.
mPulse.sendTimer("My Timer", 100);
sendMetric(name, value)Sends a Custom Metric with the specified value.
name (String) Custom Metric namevalue (Number) Custom Metric valuemPulse.sendMetric("My Metric", 2);
setPageGroup(pageGroup)Set the Page Group. All subsequent beacons will have this page group. It can be later cleared
via resetPageGroup().
pageGroup (String) Page Group namemPulse.setPageGroup("My Page Group");
getPageGroup()Gets the current Page Group.
The current Page Group, or false if one was not set.
var pg = mPulse.getPageGroup();
resetPageGroup()Resets (clears) the Page Group.
mPulse.resetPageGroup();
setABTest(bucket)Set the A/B bucket. All subsequent beacons will have this bucket. It can be later cleared
via resetABTest().
bucket (String) A/B bucketmPulse.setABTest("A");
getABTest()Gets the A/B bucket.
The current A/B Test, or false if one was not set.
var abTest = mPulse.getABTest();
resetABTest()Resets (clears) the A/B bucket.
mPulse.resetABTest();
setDimension(name, value)Set the Custom Dimension. All subsequent beacons will have this Custom Dimension. It
can be later cleared via resetDimension().
name (String) Custom Dimension namevalue (String) Custom Dimension valuemPulse.setDimension("My Dimension", "abc");
resetDimension(name)Resets (clears) a Custom Dimension.
name (String) Custom Dimension namemPulse.resetDimension(name);
setSessionID(id)Set the Session ID.
id (String) Session IDmPulse.setSessionID("ABC-123");
getSessionID()Gets the current Session ID.
The current Session ID, or false if it was not set.
var sid = mPulse.getSessionID();
startSession(id)Starts a new Session and sets the Session Length to 0.
id (String) Session ID (optional). If not specified, a new UUID is used.The new Session ID.
var sid = mPulse.startSession();
// or
var sid = mPulse.startSession("MY-SID");
incrementSessionLength()Increment the Session Length by one.
mPulse.startSession();
mPulse.incrementSessionLength();
setSessionLength(len)Sets the Session Length to the specified value.
len (Number) Session lengthmPulse.startSession();
mPulse.setSessionLength(2);
getSessionLength()Gets the Session Length.
The Session Length.
mPulse.startSession();
mPulse.setSessionLength(2);
// should be 2
var sl = mPulse.getSessionLength();
getSessionStart()Gets the Session Start.
The Session Start.
mPulse.startSession();
var st = mPulse.getSessionStart();
setSessionStart()Sets the Session Start.
mPulse.startSession();
mPulse.setSessionStart(Date.now());
transferBoomerangSession()Transfers the Session details from Boomerang (BOOMR) into mpulse.js.
This will transfer the Session ID, Start and Length from Boomerang, if it's already on the page.
mpulse.js and Boomerang do not synchronize their session details during usage. For example, if you usemPulse.incrementSessionLength(), it will
increment the Session Length for the mPulse app but not for Boomerang (BOOMR).
true on success.
mPulse.transferBoomerangSession();
subscribe(event, callback)Subscribe to events.
Available events:
before_beacon - Before a beacon is sentbeacon - After a beacon has been sentevent (String) Event namecallback (Function) Function to run when the event occursmPulse.subscribe("beacon", function() {
console.log("A beacon was sent!");
});
// initialize the app
mPulse.init("abcd-efgh-ijkl-mnop-qrst", "secret-key");
// set global settings
mPulse.setPageGroup("my page group");
mPulse.setABTest("my bucket");
// start the timer
var timerId = mPulse.startTimer("Timer1");
// ... do your work ...
// stop the timer
mPulse.stopTimer(timerId); // sends a beacon
// or, you can specify the amount of time
mPulse.sendTimer("Timer2", 500); // in ms
setABTest(), getABTest() and resetABTest() functions addedsetViewGroup() was changed to setPageGroup(). resetViewGroup() was changed to resetPageGroup()getPageGroup()init()XDomainRequestrt.tstart and rt.end on the beacon instead of when.setSessionStart(), .getSessionStart().transferBoomerangSession()sendBeaconUser-Agent for the beaconUser-Agent for the config.json fetchnode-XMLHttpRequest dependency to fix https://github.com/driverdan/node-XMLHttpRequest/pull/128 so User-Agent header is setcrypto-js@4.0.0mPulse.isInitialized() function addedUser-Agent header is no longer set in the browsercrypto-js NPM package updatednode-XMLHttpRequestFAQs
Akamai mPulse JavaScript API
The npm package mpulse receives a total of 16 weekly downloads. As such, mpulse popularity was classified as not popular.
We found that mpulse demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Following last week’s supply chain attack, Nx published findings on the GitHub Actions exploit and moved npm publishing to Trusted Publishers.
Security News
AGENTS.md is a fast-growing open format giving AI coding agents a shared, predictable way to understand project setup, style, and workflows.
Security News
/Research
Malicious npm package impersonates Nodemailer and drains wallets by hijacking crypto transactions across multiple blockchains.