Skip to main content

Admiral developer docs

Admiral runs on your site as a tag. These pages cover the three APIs you build against it.

Get startedAPI reference
page.js
// Listen for an Admiral event.
window.admiral("after", "measure.detected", function (state) {
  if (state.adblocking) {
    document.body.classList.add("adblock-enabled");
  }
});

// Open an Admiral view.
window.admiral("show", "transact.subscribe");

Browse by API

Start here

Detect adblockingRead the measure.detected payload as the page loads.React to a new subscriberUpdate your page when a visitor subscribes.Create a sessionAuthenticate and make your first JSON-RPC call.Store visitor dataWrite attributes and entries from the browser.