{"id":273,"date":"2018-12-16T23:15:39","date_gmt":"2018-12-16T23:15:39","guid":{"rendered":"https:\/\/developer.feedblitz.com\/docs\/rest-api\/api-reference\/reports-and-analytics\/"},"modified":"2018-12-21T15:00:22","modified_gmt":"2018-12-21T20:00:22","slug":"reports-and-analytics","status":"publish","type":"docs","link":"https:\/\/developer.feedblitz.com\/docs\/rest-api\/api-reference\/reports-and-analytics\/","title":{"rendered":"Reports and Analytics"},"content":{"rendered":"\n

Resource path: \/report\/<listid><\/p>\n\n\n\n

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. <\/p>\n\n\n\n

Methods:         GET,\nPOST <\/p>\n\n\n\n

Example:\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/report\/84<\/p>\n\n\n\n

Parameters are:<\/p>\n\n\n\n
Parameter<\/strong><\/td>Remarks<\/strong><\/td><\/tr>
type<\/strong><\/td>The 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<\/td><\/tr>
range<\/strong><\/td>Number of historic days\u2019 data to fetch relative to now. Default is 7, the most recent 7 days.<\/td><\/tr><\/tbody><\/table>\n\n\n\n

You can supply these parameters as URL parameters in a GET, or as XML in a POST, like this example:<\/p>\n\n\n\n

<feedblitzapi version=\"1.0\" xmlns:xlink=\"http:\/\/www.w3.org\/1999\/xlink\">\n  <report>\n  <type>11<\/type>\n  <range>7<\/range>\n  <\/report>\n<\/feedblitzapi><\/code><\/pre>\n\n\n\n
Note: Long time frames for large lists may result in time\nouts. If you encounter persistent performance problems please contact FeedBlitz\ntech support.<\/p>\n\n\n\n
The data returned by the API is analogous to the rows of the\ncorresponding tables in the FeedBlitz API. Each row\u2019s data set is surrounded by\na set of <values> tags; the tags within each set vary by report. <\/p>\n\n\n\n
Here is an example two row result set for the delivery metrics type:<\/p>\n\n\n\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<feedblitzapi version=\"1.0\" xmlns:xlink=\"http:\/\/www.w3.org\/1999\/xlink\">\n<rsp stat=\"ok\">\n<success code=\"0\" msg=\"Authorized\" \/>\n<\/rsp>\n<report>\n\t<values>\n\t\t<Cycle_ID>4030813<\/Cycle_ID>\n\t\t<Cycle>Four Hour [2011.06.14 12:00]<\/Cycle>\n\t\t<Sent>1<\/Sent>\n\t\t<Opens><\/Opens>\n\t\t<Clicks><\/Clicks>\n\t\t<Unsubs><\/Unsubs>\n\t\t<SoftBounces><\/SoftBounces>\n\t\t<HardBounces><\/HardBounces>\n\t\t<Complaints><\/Complaints>\n\t\t<Fwds><\/Fwds>\n\t<\/values>\n\t<values>\n\t\t<Cycle_ID>4030808<\/Cycle_ID>\n\t\t<Cycle>12 Hour [2011.06.14 12:00]<\/Cycle>\n\t\t<Sent>3<\/Sent>\n\t\t<Opens>3 (100.0%)<\/Opens>\n\t\t<Clicks>1 (33.3%)<\/Clicks>\n\t\t<Unsubs><\/Unsubs>\n\t\t<SoftBounces><\/SoftBounces>\n\t\t<HardBounces><\/HardBounces>\n\t\t<Complaints><\/Complaints>\n\t\t<Fwds><\/Fwds>\n\t<\/values>\n<\/report>\n<\/feedblitzapi><\/code><\/pre>\n\n\n\n
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:<\/p>\n\n\n\n
https:\/\/archive.feedblitz.com\/<listid>\/~<cycle_id><\/code><\/pre>\n\n\n\n
e.g. https:\/\/archive.feedblitz.com\/84\/~4031278<\/a> <\/p>\n","protected":false},"featured_media":0,"parent":254,"menu_order":10,"comment_status":"closed","ping_status":"closed","template":"","doc_tag":[],"class_list":["post-273","docs","type-docs","status-publish","hentry"],"comment_count":0,"_links":{"self":[{"href":"https:\/\/developer.feedblitz.com\/wp-json\/wp\/v2\/docs\/273","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.feedblitz.com\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/developer.feedblitz.com\/wp-json\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.feedblitz.com\/wp-json\/wp\/v2\/comments?post=273"}],"version-history":[{"count":2,"href":"https:\/\/developer.feedblitz.com\/wp-json\/wp\/v2\/docs\/273\/revisions"}],"predecessor-version":[{"id":442,"href":"https:\/\/developer.feedblitz.com\/wp-json\/wp\/v2\/docs\/273\/revisions\/442"}],"up":[{"embeddable":true,"href":"https:\/\/developer.feedblitz.com\/wp-json\/wp\/v2\/docs\/254"}],"next":[{"title":"Mailing Metrics","link":"https:\/\/developer.feedblitz.com\/docs\/rest-api\/api-reference\/mailing-metrics\/","href":"https:\/\/developer.feedblitz.com\/wp-json\/wp\/v2\/docs\/274"}],"prev":[{"title":"Mailing Templates and Mail Merge Shortcodes","link":"https:\/\/developer.feedblitz.com\/docs\/rest-api\/api-reference\/mailing-templates\/","href":"https:\/\/developer.feedblitz.com\/wp-json\/wp\/v2\/docs\/272"}],"wp:attachment":[{"href":"https:\/\/developer.feedblitz.com\/wp-json\/wp\/v2\/media?parent=273"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/developer.feedblitz.com\/wp-json\/wp\/v2\/doc_tag?post=273"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}