Data Services

BouncePilot data services are used to provide information about visitors and their actions on the site. The data is prepared nightly and available for delivery every morning.

Retrieving the data can be done either via Account UI by downloading a ZIP file of CSV files or via authenticated REST API.

Data format

Data provided by the service, either in a CSV file or in a JSON when calling our REST API contains the following fields:

Field Contains
email Plain text email.
campaign Campaign name - the campaign level with the highest value seen during the visit.
timeOnSite Time between the 1st and the last interaction event during the visit.
timeOnSiteStart Time of the 1st interaction event that occurred during the visit.
timeOnSiteEnd Time of the last interaction event that occurred during the visit.
pageInitCount Count of all page load events seen during the visit
uniquePageInitCount Unique count of visited pages.
pageInits URLs collected from page load events.
uniquePageInits Unique URLs collected from page load events
visitCount How many times did the user visit the page?
correlationId BouncePilot Lifecycle ID.
visitIds List of all Visit ID values sent in event to BouncePilot API.

Account UI

Your BouncePilot account can be used to retrieve a ZIP file.

Your login credentials will be provided to you by your account manager. Log in with those credentials:

Then, select a date:

Wait a few moments until your data are ready:

Once it’s ready, you can download the newly created file:

Data API

Your data can also be retrieved via REST API.

Server URL https://api.bouncepilot.com
Authentication method HTTP basic auth
Credentials Same as those used for accessing the Account UI - will be provided to you by your account manager.

Retrieving data in JSON

This call will return all available data for the specified date range, formatted in JSON.

HTTP Method 
GET
Endpoint 
/v1/bopi-data/{your advertiser id}/export
In 
{"startDate": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", "endDate": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"}

Retrieving a ZIP file

Downloading your data in a ZIP file takes 3 steps:

  1. Request file generation.
  2. List files to check the file you requested is ready for a download.
  3. Download the file.

Data file generation request

Request for generating export data files.

When an advertiser requests data from the UI, the data is generated, and a ZIP file is stored on our server. You can retrieve the data by accessing this server.

HTTP Method 
POST
Endpoint 
/v1/bopi-data/{your advertiser id}/
In 
{"startDate": "yyyy-MM-dd", "endDate": "yyyy-MM-dd"}

List your generated files

Endpoint for retrieving files list from the Advertisers API server.

HTTP Method 
GET
Endpoint 
/v1/bopi-data/{your advertiser id}/

Download your generated file

HTTP Method 
GET
Endpoint 
/v1/bopi-data/{your advertiser id}/files/{file name}