Brizy Analytics helps you understand how visitors interact with a website, including how many people visit, where they come from, which pages they view, and what devices and browsers they use.
As a White Label or API partner, you can use the Brizy Cloud API to:
- Enable Analytics for individual website projects
- Retrieve Analytics data and display it inside your own dashboard or platform
- Enable Analytics across multiple projects by processing them one at a time
Analytics is available for Pro website projects only.
API Explorer
You can access the API Explorer here:
https://[your-white-label-dashboard-domain]/api/doc/v2
Replace [your-white-label-dashboard-domain] with the White Label dashboard domain provided during your onboarding.
Enable Analytics for a Project
Use the Enables analytics for a Project endpoint to activate Analytics for a specific website project.
The project does not need to be published when Analytics is enabled. Tracking will begin the next time the project's pages are compiled.
If Analytics is already enabled for the project, calling the endpoint again is safe and will not create a duplicate Analytics site.
Possible responses
- 201 - Analytics was successfully enabled
- 200 - Analytics was already enabled
- 403 - The project is not on a Pro plan
- 422 - Analytics is not supported for this project type
Analytics are currently not available for Popup, Story type projects.
Retrieve Analytics Data for a Project
Use the Retrieves the visit statistics of a Project endpoint to retrieve Analytics data for a project that already has Analytics enabled.
You can request data for one of the following periods:
todaylast7last30last90
The API response includes:
- Total visits
- Visits per day
- Top 5 pages
- Top 5 landing pages
- Top 5 traffic sources
- Top 5 referring websites
- Top 5 devices
- Top 5 browsers
- Top 5 countries
All dates and times are returned in UTC.
Analytics responses can be cached for up to 90 seconds. If Analytics has just been enabled for a project, the first response may therefore contain zero values until visit data becomes available.
If Analytics has not been enabled for the requested project, the API returns 404.
Enable Analytics for Multiple Projects
There is currently no single bulk API endpoint for enabling Analytics across multiple projects.
To enable Analytics for multiple websites, first retrieve the projects from the relevant workspace using Retrieves a list of Projects.
See the Projects documentation for more information.
When retrieving projects:
- Use the
type=websitefilter - Retrieve up to 200 projects per page
- Decide which projects should have Analytics enabled
You can enable Analytics for all eligible websites, a selected group of websites, or a list of projects maintained in your own system.
Once you have the list, call Enables analytics for a Project separately for each project.
Important
Process the requests one after another rather than in parallel and check the response from each request.
Handle the responses as follows:
- 201 - Analytics was enabled successfully. Continue to the next project.
- 200 - Analytics was already enabled. Continue to the next project.
- 403, 404 or 422 - Analytics cannot be enabled for that project. Record the result and continue to the next project.
- 424 - Wait for the number of seconds specified in the
Retry-Afterresponse header, then retry the request once.
If the second attempt also returns 424, stop the process and contact Brizy Support with the error details.
The operation is safe to repeat. If the process is interrupted, you can restart it without creating duplicate Analytics sites for projects that were already processed.