1. Home
  2. Docs
  3. REST API
  4. API Reference
  5. Mailing Metrics

Mailing Metrics

Resource path: /metrics/<listid>

This report returns the summary metrics for an individual mailing / cycle ID. It is analogous to the mailing summary report in the UI. An optional “since=<mailingid>” parameter may be passed in the URL and data will only be returned for mailings since that ID, otherwise all mailings will be returned.

For old lists that mail frequently, getting all the mailing IDs may be a very time consuming process, and we strongly recommend limiting the scope of the call using “since” or an individual mailing ID.

All data returned is real-time.

Optional Parameters

ParameterComments
sincepass a mailingid, only data for mailings after this ID will be returned.
mailingidFor detailed metrics, send the cycleid as an xml entity in the POST, or as a parameter on the URL.
detailFor subscriber level detail, add this parameter to URL. The allowed values are:

opens, clicks or links.

For opens and clicks you get the subscriber email and how many times they opened the mailing, or how many links they clicked within it. For links you get the subscribers and the individual links clicked in the mailing.

This last level of details (subscriber by link) is only available for mailings IDs greater than 6055042.

Methods:         POST

Example:         /metrics/84

Posted XML:

<feedblitzapi version="1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
  <metrics>
  <mailingid>4976718</mailingid>
  </metrics>
</feedblitzapi>

Response XML:

<?xml version="1.0" encoding="UTF-8"?>
<feedblitzapi version="1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
<rsp stat="ok">
<success code="0" msg="Authorized" />
</rsp>
<metrics>
<sent>26243</sent>
<opens>2479</opens>
<uniqueopens>1933</uniqueopens>
<clicks>724</clicks>
<uniqueclicks>101</uniqueclicks>
<unsubscribes>33</unsubscribes>
<softbounces>17</softbounces>
<hardbounces>31</hardbounces>
<complaints>3</complaints>
<forwards>0</forwards>
</metrics>
</feedblitzapi>

Currently metrics are not available for A/B test detail if an A/B test has been run from a Newsflash / Single Mailing Campaign in the FeedBlitz UI.