1. Home
  2. Docs
  3. REST API
  4. API Reference
  5. Reports and Analytics

Reports and Analytics

Resource path: /report/<listid>

The report resource parallels the reports available in the FeedBlitz user interface. The default (used by a simple GET) is the delivery metrics report for the selected list covering the most recent 7 days.

Methods:         GET, POST

Example:         /report/84

Parameters are:

ParameterRemarks
typeThe type of report requested. Valid types are:

0: Click through summary
2: Open analysis
5: Click throughs by reader
6: Opens by reader
7: Click throughs by tag
9: Unsubscribe summary
10: New subscription referrers
11: Delivery metrics
12: Engagement
13: Subscriber count history
rangeNumber of historic days’ data to fetch relative to now. Default is 7, the most recent 7 days.

You can supply these parameters as URL parameters in a GET, or as XML in a POST, like this example:

<feedblitzapi version="1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
  <report>
  <type>11</type>
  <range>7</range>
  </report>
</feedblitzapi>

Note: Long time frames for large lists may result in time outs. If you encounter persistent performance problems please contact FeedBlitz tech support.

The data returned by the API is analogous to the rows of the corresponding tables in the FeedBlitz API. Each row’s data set is surrounded by a set of <values> tags; the tags within each set vary by report.

Here is an example two row result set for the delivery metrics type:

<?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>
<report>
	<values>
		<Cycle_ID>4030813</Cycle_ID>
		<Cycle>Four Hour [2011.06.14 12:00]</Cycle>
		<Sent>1</Sent>
		<Opens></Opens>
		<Clicks></Clicks>
		<Unsubs></Unsubs>
		<SoftBounces></SoftBounces>
		<HardBounces></HardBounces>
		<Complaints></Complaints>
		<Fwds></Fwds>
	</values>
	<values>
		<Cycle_ID>4030808</Cycle_ID>
		<Cycle>12 Hour [2011.06.14 12:00]</Cycle>
		<Sent>3</Sent>
		<Opens>3 (100.0%)</Opens>
		<Clicks>1 (33.3%)</Clicks>
		<Unsubs></Unsubs>
		<SoftBounces></SoftBounces>
		<HardBounces></HardBounces>
		<Complaints></Complaints>
		<Fwds></Fwds>
	</values>
</report>
</feedblitzapi>

Where present, the <cycle_id> inner content directly maps to a single send (i.e. a mailing id) and its corresponding archive URL, of the form:

https://archive.feedblitz.com/<listid>/~<cycle_id>

e.g. https://archive.feedblitz.com/84/~4031278