Returns metrics for a given push notification
Endpoint URL: https://api.carnivalmobile.com/v6/stats/notifications/:notification_id/events
Parameters
| Name | Type | Required | Definition |
|---|---|---|---|
| notification_id | string | Yes | The ID of the notification as reported from the Notifications API response. Use the id inside the notification object. |
Examples
Copy
curl -X GET -u :$API_KEY -H 'Accept: application/json' https://api.carnivalmobile.com/v6/stats/notifications/$notification_id/eventsResult Format
200 OK
Copy
{
"id": "58c9aa0c3431340008855116",
"audience_id": "58210c663963320008001767",
"message_id": "5a0ca8c2fbf958de806ef92d",
"push_text": "Check out this sweet deal!",
"published_time": "2017-03-15T20:54:36.675Z",
"direct_opens": 100,
"indirect_opens": 50,
"influenced_opens": 150,
"opens": 100,
"pushes_succeeded": 200,
"pushes_rejected": 0,
"event_conversions": {
"purchase": 4
}
}Copy
{
"error":"unauthorized"}403 Forbidden
Copy
{
"error":"your api client does not have the correct roles"}This endpoint returns data and metrics for a given Push Notification ID. Metrics are updated in real time. Influenced opens (including direct and indirect) and events are counted using our standard attribution windows.
| Field | Type | Description |
|---|---|---|
|
id
|
String
|
The Push Notification ID
|
|
audience_id
|
String
|
Audience ID of the targeted audience. Each audience (including on-the-fly audiences) will have its own ID.
|
|
message_id
|
String
|
Message ID of the message the notification belongs to.
|
|
push_text
|
String
|
The body of the push alert
|
|
published_time
|
Date
|
Date when the push notification was sent
|
|
direct_opens
|
Integer
|
How many times users opened the app as a result of tapping the push alert directly
|
|
indirect_opens
|
Integer
|
How many times users opened the app as a result of receiving a push notification, then opening the app without interacting with the push alert
|
|
influenced_opens
|
Integer
|
Sum of direct_opens and indirect_opens
|
|
opens
|
Integer
|
Same as direct_opens
|
|
pushes_succeeded
|
Integer
|
Number of pushes sent based on gateway status (i.e. valid push tokens)
|
|
pushes_rejected
|
Integer
|
Number of pushes rejected based on gateway status (i.e. invalid push tokens)
|
|
event_conversions
|
Dictionary<String, Integer>
|
A list of custom events where the key is a custom event and the value is the number of occurrences of this event
|
