The Email API allows the publisher to get the components of an ad to serve in their push notification. It must be called each time an email is sent. Widget results are returned as a JSON object, and settings (type of content, etc.) are managed in the domain and widget sections of the admin.

Setting Up the API Call

  1. Set up an Email-API widget in the admin. Performance reports can be broken out by widget or domain. If the domain is new, it must be approved by the team before showing sponsored content. We recommend setting up a separate domain for email, using email as a subdomain (i.e. so that performance of email traffic will be separated from on-page traffic.
  2. Copy the installation code provided. Insert the user's IP Address, User Agent, and User ID into the parameters, encoding all values.

Copy code here:[Unique Widget ID]/[Unique Domain ID]/?url=[Domain URL (URL encoded)]&ipAddress=[Visitor's IP Address]&userAgent=[Visitor's User Agent String (URL encoded)]&pushid=[Unique User ID]

Please note: The visitor's IP address and encoded user agent included above are only needed when the API call is made server-side.

Query String Parameters

 Example JSON Result Set

  "slot": 1,
  "url": "",
  "title": "A Very Interesting Article You May Like",
  "image": ""
  "sponsored": false
  "sponsored_by": ""

The performance score is a general indication of performance across our network. It will not accurately predict relative performance across all networks and should only be used as a guide.


api version: 1.0.0

Did this answer your question?