API Analytics
API analytics is an API with easy integration to fetch the data coming from the usage of Zelros features.
Query parameters
| Name | Required | Description |
|---|---|---|
granularity |
required |
|
start_date |
required |
yyyy-MM-ddTHH:mm:ss.SSSZ |
end_date |
required |
yyyy-MM-ddTHH:mm:ss.SSSZ |
key |
required |
day, week, month, year |
'granularity' possible values: - day - week - month - year
| Metric Key | Description |
|---|---|
total_users |
Total number of users who have access to the app (if available) |
active_users |
Total number of users who had at least one recommendation in the last 2 months |
connected_users |
Number of all the users who were connected to the Advisor app over the period |
engaged_users |
Number of users who received at least one notification |
notification_active_users |
Number of users who clicked & opened at least one notification |
displayed_notifications |
Number of notifications displayed |
opened_notifications |
Number of opened notifications |
number_of_triggers |
The number of identified customers |
life_event_displays |
Number of times a life event was displayed over the period |
selling_point_displays |
Number of times a selling point was displayed over the period. |
decisions |
Number of decisions (Quote/No quote/ Meeting) |
api_calls |
Number of calls to the API |
Example response
[
{
"start_date": "2022-01-01T00:00:00.000Z",
"end_date": "2022-02-01T00:00:00.000Z",
"count": 2051
},
{
"start_date": "2022-02-01T00:00:00.000Z",
"end_date": "2022-03-01T00:00:00.000Z",
"count": 76245,
"label": "Test argument Car",
"positive": 0,
"negative": 0,
"suggestions": 0,
"products": [
"Health"
]
},
{
"start_date": "2022-03-01T00:00:00.000Z",
"end_date": "2022-04-01T00:00:00.000Z",
"count": 46,
"label": "Test argument Car",
"positive": 0,
"negative": 0,
"suggestions": 0,
"products": [
"Pet"
]
},
{
"start_date": "2022-03-01T00:00:00.000Z",
"end_date": "2022-04-01T00:00:00.000Z",
"count": 353,
"label": "Test argument Car",
"positive": 0,
"negative": 0,
"suggestions": 0,
"products": [
"Home"
]
},
{
"start_date": "2022-04-01T00:00:00.000Z",
"end_date": "2022-05-01T00:00:00.000Z",
"count": 30,
"label": "Test argument Car",
"positive": 0,
"negative": 0,
"suggestions": 0,
"products": [
"Car"
]
}
]