Data Export API
You can use Browsee's data export API to get and store data collected by Browsee.
Browsee automatically collects data about all the sessions that happen on your site. In case you have any of the following requirements, you can utilize our data export API
- Saving data beyond Browsee's data retention limit
- Creating or generating reports beyond the scope of Browsee's analytics.
- Augment your own data with data collected from Browsee.
In order to get started, please generate a secret key and read about the data export APIs below.
Session export API gives you all the details related to users and sessions either without any constraint or based on an existing circle in your account. Please note the following points.
- It only supports
- This is a pagination based API. The page size by default is 100 sessions.
- In your first request, you will get the total number of results and the offset index up to which sessions have been exported. You can send more requests with changing the offset parameter (
from) to get subsequent sessions.
- As an example, the first request will return documents starting from 0 upto 100. In the next request you can send
fromto be 100 and this time you will get documents from 100 to 200 and so on.
- Its rate limited to one open request. You must wait for the response from one request before initiating another request.
You can send an optional parameter:
segmentIdto get the sessions for that segment. To get the segment Id, you can go to the list of Segments and click on View Analytics for the desired segment.
This segment's ID is the ID in the URL of the analytics page as shown
Segment ID in URL
To limit the number of fields and data provided, you can provide additional parameters like below to give the list of fields that you need.
apiKey: <API Key>,
secretKey: <Secret Key>,
select: ['userId', 'urls', 'duration']
Here is a list of fields that you can provide in
userId: User ID, as provided by
duration: Duration in milliseconds of the session.
inactiveTime: Duration during which user was inactive during the session (milliseconds).
activeTime: Difference between duration and inactiveTime (milliseconds).
urls: URL's visited in the session
timestamp: Unix timestamp in milliseconds since the epoch of the start of the session
pageCount: Number of pages visited
eventCount: Number of events found
name: Name if provided in
tags: Tags if provided in
landingPage: Landing Page of session
utm_source/utm_medium/utm_campaign/utm_term/utm_content: UTM Parameters
browser: User's Browser
os: Operating System
device: User's device
isMobile: If the device is considered to be Mobile
ip: IP from which session originated
city: City detected (based on IP)
country: Country detected (based on IP)
domain: Domain from which session was recorded
referrer: Referrer of the session (only the domain)