GET Stats / Transactional Notifications

Contents

Parameters
- Path Parameters
- Query Parameters
Examples

cURL
cURL
- Result Format
200 OK
401 Unauthorized
403 Forbidden

Returns metrics for a given transactional notification group

Endpoint URL: https://api.carnivalmobile.com/v6/transactional/notifications/:group/stats

Parameters

Path Parameters

Name	Type	Required	Definition
group	string	Yes	Group identifier

Query Parameters

from	yyyy-mm-dd
to	yyyy-mm-dd

Examples

cURL

curl -X GET -u :$API_KEY -H 'Accept: application/json' https://api.carnivalmobile.com/v6/transactional/notifications/$group/stats

cURL

curl -X GET -u :$API_KEY -H 'Accept: application/json' "https://api.carnivalmobile.com/v6/transactional/notifications/$GROUP/stats?from=2020-08-01&to=2020-12-01"

Result Format

200 OK

{
  "group": "coupon-codes",
  "direct_opens": 10,
  "indirect_opens": 100,
  "notifications_sent": 1000,
  "event_conversions": {
    "my event": 5
  },
  "purchase_conversions": [
    {
      "name": "item_name_1",
      "total_value": 10,
      "count": 1
    },
    {
      "name": "item_name_2",
      "total_value": 100,
      "count": 2
    }
  ]
}

401 Unauthorized

{
  "error":"unauthorized"
}

403 Forbidden

{"error":{"reason":"unauthorized"}}

This endpoint returns data and metrics for a given transactional notification group. Metrics are updated in real time. Influenced opens (including direct and indirect), events and purchases are counted using our standard attribution windows. It supports the use of date ranges to filter the result set. This must be done in the format YYYY-mm-dd.

Field	Type	Description
`group`	String	The transactional notification group
`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
`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
`purchase_conversions`	Array[PurchaseItem<name: String, total_value: Integer, count: Integer>]	A list of purchase objects attributed to the transactional push group, containing name, total value and count. Note that `total_value` is an integer number of cents, so a purchase worth $10 will show as 1000.