We’re excited to introduce Event APIs to help you easily fetch event data from your NotifyVisitors account. Whether you want to integrate user activity into your own dashboards, internal tools, or third-party platforms, these APIs make it simple and flexible.
A. API for date-wise event counts
This API provides a breakdown of your event data on a daily, weekly, monthly, or yearly basis. You can access the number of total events, unique users performing the event, or unique sessions of the event. You can also filter your requested data based on event attributes.
Make sure to include the date range, trend metric, and event name in your request body for precise data retrieval.
Here’s an example for the same:
Sample request :
“brandID”: “8194XX”,
“fromDate”: “2024-04-01”,
“toDate”: “2024-04-04”,
“timeseries”: “daily”,
“trend_metric”: “unique_users”,
“event_name”: “order_place”,
“event_property”: [
{
“key”: “Attributes – product_category”,
“operator”: “Include”,
“value”: “Clothes”
}
]
}
Kindly go through our documentation “Get Date wise events counts” for API endpoint or to request API data without needing to write any code.
The API will respond with the event counts distributed across the specified date range, along with the total count
Here is a response for the above example API passed:
Sample response :
“status_code”: 200,
“message”: “success”,
“response”: {
“data”: {
“2024-08-01”: 10,
“2024-08-02”: 4,
“2024-08-03”: 9,
“2024-08-04”: 2
},
“totalCount”: 25
}
}
B. API for events counts with data breakdown by property
This API allows you to request event counts and customize the response by any event property or attribute. You can receive up to 100 values per request, or set your own limit.
For instance, you can discover the most popular languages used during a ‘form_submission’ event.
Sample request :
“brandID”: “8194XX”,
“fromDate”: “2025-04-01”,
“toDate”: “2025-04-31”,
“trend_metric”: “total_events”,
“event_name”: “form_submission”,
“event_property”: [
{
“key”: “Attributes – category”,
“operator”: “Include”,
“value”: “equity_funds”
}
],
“attribute_name”: “language”,
“limit”: 3
}
Here, the limit defines how many top property values you want to retrieve. For instance, if there are 50 different languages but you set the limit to 3, the API will return only the top 3 languages based on the number of form submissions.
Sample response :
“status_code”: 200,
“message”: “success”,
“response”: {
“data”: {
“English”: 42,
“Spanish”: 23,
“Hindi”: 34
}
}
}
Kindly go through our documentation titled “Get event property breakdown data” for information on the API endpoint or to request API data without needing to code.
C. API for collecting event logs:
Just like checking the event count, you can also ask for logs related to your events. This API allows you to fetch detailed event logs for any selected event. You can apply filters based on event attributes to refine your search. The system returns up to 10,000 event logs per request, and you can adjust the limit if you require fewer logs.
For detailed information on setting up and using this API, refer to our guide “Get the Event Logs of Specific Event.”
With these new Event APIs, you can effortlessly build custom dashboards, generate detailed reports, or simply explore user engagement trends like never before — all directly from your NotifyVisitors account.