Skip to main content

Subscriber Analytics

The subscriber analytics summary provides stats on active subscribers for the entire site, breaking down the distribution of active subscribers across various dimensions, including categories like city, country, state, browser, and device. The response is in JSON format.

GET
 https://api.pushengage.com/apiv1/subscribers/analytics/summary

Request Parameters

Parameter NameTypeRequiredDescription
typeStringNoA comma-separated list of dimensions to be included in the response. Allowed dimensions include country, state, city, device, device_type, and platform. If the "type" parameter is not specified, the response will include all available dimensions.

Response Object

Property NameTypeRequiredDescription
successBooleanYesIndicates whether the subscribers' analytics summary request succeeded or not. Value can be 'true' or 'false'.
dataObjectYesSummary of subscriber statistics.

Example

Request

curl -X GET \
'https://api.pushengage.com/apiv1/subscribers/analytics/summary' \
-H 'Accept: */*' \
-H 'Api_key: <your_pushengage_api_key>' \
-H 'Connection: keep-alive' \
-H 'Content-Type: application/json' \

Response

{
"success": true,
"data": {
"city": {
"Bangalore": 40
},
"country": {
"India": 100
},
"device": {
"desktop": 30
},
"device_type": {
"chrome": 40
},
"state": {
"Karnataka": 10
}
}
}