Exporting Reports via API
You can use the reports export API to automatically or manually
request reports in CSV format.
The first line of the report contains columns names.
How to export reports
To export reports you need an API access point. Get it from the
settings page on the console.
Find the Reports export API section and copy the
access URL from there. If required click Get new reports
export access URL first.
The API access URL is in this format:
https://cbar.barilliance.com/api/export.php?sid=1&key=65a7d277a74814fb50d8b62
To use the API you need to add parameters such as action, from_date
and to_date.
A full API call URL looks like this:
http://cbar.barilliance.com/api/export.php?sid=575&key=65a7d277a74814fb50d8b62&action=triggered_emails_report&date_from=2015-02-08&date_to=2015-02-11
To download a file compatible with Microsoft Excel add &excel=true to the API call URL
Available reports
Triggered Emails report
Action to use in URL : triggered_emails_report
The report specify the performance of triggered emails on daily
basis.
Columns explanation:
sent_date - The date of sending. format: 2015-02-08
sent - Number of emails sent
opened - Number of emails opened
clicked - Number of emails clicked
converted - Number of emails which resulted in conversion
email_type - 0 = Cart Abandonment, 1=Email My cart, 2= Site
Abandonment (no cart items or purchase), 3= Post Purchase, 4= Back
to stock 5= Visit Summary
rule_number - Which Barilliance rule triggered this email
site_id - Your site id
Product Recommendations report
Action to use in URL : recommendations_report
The report specify the performance of onsite product recommendations
Columns explanation:
date - The date of this report row. format: 2015-02-08
uniques_exposed - number of unique visitors who have been served
with recommendations
uniques_clicked - number of unique visitors who clicked on
recommendations
uniques_converted - unique visitors who have bought a product
clicked as recommendation
value - the total amount in the site currency of revenues generated
by clicked products
views - Number of page views in which a recommendation widget was
shown
clicks - Number of clicks on recommendations
views_H - Home page views with at least one recommendations
widget
views_P - Product page views with at least one recommendations
widget
views_C - Category page views with at least one recommendations
widget
views_S - Search page views with at least one recommendations
widget
views_Sc - Cart page views with at least one recommendations
widget
views_O - 'other' page type views with at least one recommendations
widget
views_OOS - Out of stock page views with at least one
recommendations widget
views_U - Unspecified page views with at least one recommendations
widget
views_Pu - Purchase page views with at least one recommendations
widget
The following columns represent number of clicks on the various page types:
clicks_H
clicks_P
clicks_C
clicks_S
clicks_Sc
clicks_O
clicks_OOS
clicks_U
clicks_Pu
- Note: By default the recommendations are produced by the recommendation engine also for pages that does not have a visible widget. Therefore you should ignore the data for page types which doesn't contain a visible widget.