Emails export API

Barilliance collects emails from visitors as they are typed in your website. These emails can be exported automatically via API calls.

Getting API access

To get access to the API you need a unique URL that holds a random key, known only to you.
To get the API key, visit the 'settings' section of the management console. A key URL looks like this

https://cbar.barilliance.com/api/export.php?sid=575&key=c4cdc2ed222b9693fce8659xxxx6641b

Exporting collected emails

To get the list of all emails of visitors who have visited during specific dates add the following parameters to the API access URL.

&action=collected&date_from=2015-03-08&date_to=2015-03-11

Notes

  • A visitor email will be returned even if the email was entered in past sessions and not during the last visit.

  • The above action will export emails even if they were opted out. To export collected emails excluding opted out emails use the action collected_not_optout It will exclude any emails opted out in the past (not only in the specified dates)

Exporting opt out emails

To get the list of opt out emails for specific dates add the following parameters to the API access URL

&action=optout&date_from=2015-03-11&date_to=2015-03-11

Exporting Sent emails

To get a csv list of all the sent emails with email types for specific dates add the following parameters to the API access URL

&action=sent&date_from=2015-03-11&date_to=2015-03-11

Sample output:

time,email,email_type
"2016-02-08 17:42:06",bill_clinton@comcast.net,0
"2016-02-08 17:42:06",george_bush@verizon.net,2
"2016-02-08 17:44:03",barak_obama@telecom.co.nz,0
"2016-02-08 17:46:02",john_kennedy@rogers.com,3
"2016-02-08 17:46:03",abraham_lincoln@gmail.com,2

The 3rd parameter is a number with these values:
0: shopping cart abandonment. 1: email my cart. 2: browse abandonment. 3:post purchase email, 4: back to stock reminder 5: visit summary email

General notes

  • Date format is YYYY-MM-DD in New York time zone

  • Return values are email addresses, on per line

  • Possible return values in case of error: invalid access key, invalid action, no results

  • Results are limited to 30000 emails

  • to save a file in Microsoft Excel format add &excel=true to the URL