You can use this service to get analytics for the Single Push notifications sent today using a predefined web service. These analytics include the campaigns created from the beginning of the day (00:00 UTC) to the time of the API request. For instance, if you send a request at 14:50, the system converts 14:50 to UTC and returns the campaigns created between 00:00 UTC and the converted UTC timestamp.
Endpoint and Headers
POST https://mobile.useinsider.com/api/v1/notification/get_statistics
Header | Sample Value |
|---|---|
Content-Type | application/json |
Body Parameters
Parameter | Description | Data Type | Required |
|---|---|---|---|
api_key | Your API key. Refer to API Authentication Tokens to get your API key. | String | Yes |
Sample Example
Sample Body
{
"api_key": "Your API Key goes here"
}Sample Responses
200 OK
The successful response will return the following metrics:
Parameter | Definition |
|---|---|
id | Campaign ID |
name | Campaign name |
delivery_count | The number of users the campaign is delivered to |
session_count | The number of users who open the campaign |
open_rate | Opens/deliveries |
message | The campaign message |
title | The campaign title |
segment_name | The name of the segment that is targeted in the campaign |
deep_link/deep link key | The deep link the users are redirected to |
push_image | The image URL of the campaign |
{
"campaigns": [
{
"id": Camp ID,
"name": "My message",
"delivery_count": 10,
"session_count": 10,
"open_rate": "Campaign's Open Rate",
"message": "Campaign's Message ",
"title": "Campaign's Title",
"segment_name": "Campaign's Segment Name",
"deep_link": {
"Deep Link Key": "Deep Link Value"
},
"push_image": "Image URL"
}
]
}401 Unauthorized
This response indicates that the API key is invalid or incorrect.
{
"error": "Bad Api Key."
}401 Unauthorized
The following response returns if the API key is empty. You need to get your API key from the panel.
Api key can not be empty.Limitations
All functions must be executed with a simple HTTPS POST request.
The API key should be provided in the request body. If the key is incorrect, no operation will be executed.