GET Stats / Transactional Notifications

Returns metrics for a given transactional notification group

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

Parameters

Path Parameters

Query Parameters

Examples

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

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

{
  "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
    }
  ]
}

{
  "error":"unauthorized"}

{"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.