1. Home
  2. Docs
  3. Transactional API
  4. API Reference
  5. Analytics and Search

Analytics and Search

End Point

https://app.feedblitz.com/f/?TxnMetrics

Parameters may be provided as (HTTP encoded) URL parameters in a GET (total URL length MUST be < 2048 bytes or the GET will fail); or multipart form variables in a POST. If a variable is in both the URL and POSTed form data, the URL parameters take precedence. All parameter names are case insensitive.

Metrics are available for mailings (TxnMetrics), licensing (TxnMetrics=licenses) and billing (TxnMetrics=billing). Billing and license summaries are very similar, except that licensing summarizes by product.

Note that licenses and billing calls return metrics for products and licenses first seen in the specified month; they’re not a running total, and they do not take into account the product or license’s current status.

Metrics are delivered for the current month by default.

Parameters

The following parameters are available for all three forms of the metrics end point.

ParameterRemarks
apikeyRequired. Your transactional mailing API key.
licenseRestrict results to just this particular license.
productRestrict results to just this particular product name.
detail1 to show all results as well as the summary. Default: 0.
dateShow for the month containing this date (Format: yyyy-mm-dd)

In addition, the following parameters are available for the mailing metrics call (i.e. plain TxnMetrics):

ParameterRemarks
idFilter by the ID you provided with the email
tagsFilter by the tags you provided with the email
emailidFilter by individual email using the email’s UUID given to you by FeedBlitz
fromFilter by the sending address used
emailFilter by receiving email address (does not include CC or BCC)
groupbySummarize results. Valid values for this parameter are one of:
id, tags, email, from, product, license

Results are returned as XML. If filters are used they will be noted; there will be one or more elements for each element specified by the groupby parameter. If detail=1 is specified, there will be info elements for each individual element.

Billing Results Example (TxnMetrics=billing)

<txnMetrics>
<billingSummary>
<filters>
<product>feedblitz blogger</product>
</filters>
<entry>
<month>2017-11</month>
<newLicenses>4</newLicenses>
<fee>USD 20</fee>
</entry>
<licenseInfo>
<license>d32f5a08-bce9-11e7-9c6e-a0a8cd7c058c</license>
<firstSeen>2017-11-03 12:49:04</firstSeen>
<product>FeedBlitz Blogger</product>
<fee>USD 5</fee>
</licenseInfo>
<licenseInfo>
<license>xyzf5a08-bce9-11e7-9c6e-a0a8cd7c058c</license>
<firstSeen>2017-11-10 14:49:51</firstSeen>
<product>FeedBlitz Blogger</product>
<fee>USD 5</fee>
</licenseInfo>
<licenseInfo>
<license>999f5a08-bce9-11e7-9c6e-a0a8cd7c058c</license>
<firstSeen>2017-11-10 14:53:17</firstSeen>
<product>FeedBlitz Blogger</product>
<fee>USD 5</fee>
</licenseInfo>
<licenseInfo>
<license>321f5a08-bce9-11e7-9c6e-a0a8cd7c058c</license>
<firstSeen>2017-11-11 12:04:27</firstSeen>
<product>FeedBlitz Blogger</product>
<fee>USD 5</fee>
</licenseInfo>
</billingSummary>
</txnMetrics>

Email Metrics Results Example

This query (plain old TxnMetrics) had groupby=license specified:

<txnMetrics>
<metrics>
<filters>
<from>phil@hollows.com</from>
</filters>
<entry>
<month>2017-11</month>
<received>8</received>
<sent>8</sent>
<opens>5</opens>
<bounces>1</bounces>
<complaints>1</complaints>
<license>d32f5a08-bce9-11e7-9c6e-a0a8cd7c058c</license>
</entry>
<entry>
<month>2017-11</month>
<received>1</received>
<sent>1</sent>
<opens>0</opens>
<bounces>0</bounces>
<complaints>0</complaints>
<license>xyzf5a08-bce9-11e7-9c6e-a0a8cd7c058c</license>
</entry>
<entry>
<month>2017-11</month>
<received>5</received>
<sent>3</sent>
<opens>1</opens>
<bounces>0</bounces>
<complaints>0</complaints>
<license>999f5a08-bce9-11e7-9c6e-a0a8cd7c058c</license>
</entry>
</metrics>
</txnMetrics>

Other fields that may appear in in each include:

<attachments>Number of emails with an attachment
<ccs>Number of emails with one or more valid addresses CC’d
<bccs>Number of emails with one or more valid addresses BCC’d

Performance, Efficiency and Scale

  • Avoid detail=1 without providing filters. These datasets can be huge, and the query might time out on you (if it does, retry it).
  • If searching metrics for a client, find their license ID in your system and apply that as filter; it’s much more efficient than searching on the from address and filtering by product name:
  • e.g. I sent email from “Plugin Pro” today to “joe@example.com” – when did he open it? Best API parameters to use: License=xyz1234&email=joe%40example.com&detail=1