{"_id":"5c50f1b65319c6006211fbf5","project":"55e67aaa9cc7c62b00c4a1ea","version":{"_id":"5b720760c44b7600034b7a08","project":"55e67aaa9cc7c62b00c4a1ea","__v":0,"forked_from":"5b1f2cbdfd653400031d8d9f","createdAt":"2015-09-02T04:27:23.612Z","releaseDate":"2015-09-02T04:27:23.612Z","categories":["5b720760c44b7600034b79a7","5b720760c44b7600034b79a8","5b720760c44b7600034b79a9","5b720760c44b7600034b79aa","5b720760c44b7600034b79ab","561c61b4ad272c0d00a892df","586c014c0abf1d0f000d04d4","58991d2ad207df0f0002186b","5b720760c44b7600034b79ac","5b720760c44b7600034b79ad","5af0fe494ca2730003cbc98a","5af0fe55ec80af0003804ca2"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"API V6","version_clean":"1.4.0","version":"1.4"},"category":{"_id":"5b720760c44b7600034b79a9","__v":20,"pages":["5b720760c44b7600034b79c0","55ed079b0d968e2100de8339","5b720760c44b7600034b79c1","55ed0bb078319821005005cf","5b720760c44b7600034b79c2","5b720760c44b7600034b79c3","5b720760c44b7600034b79c4","5b720760c44b7600034b79c5","5b720760c44b7600034b79c6","5b720760c44b7600034b79c7","5b720760c44b7600034b79c8","5b720760c44b7600034b79c9","5b720760c44b7600034b79ca","5b720760c44b7600034b79cb","5b720760c44b7600034b79cc","5b720760c44b7600034b79cd","5b720760c44b7600034b79ce","5b720760c44b7600034b79d6","5b720760c44b7600034b79d7","5b720760c44b7600034b79df"],"project":"55e67aaa9cc7c62b00c4a1ea","version":"5b720760c44b7600034b7a08","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-02T04:30:21.948Z","from_sync":false,"order":5,"slug":"rest-api","title":"REST API"},"user":"56e5d6f82d90970e00af1b92","__v":3,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-01-30T00:37:10.399Z","link_external":false,"link_url":"","sync_unique":"","hidden":true,"api":{"method":"get","examples":{"codes":[{"name":"","code":"curl -X GET -u :$API_KEY -H 'Accept: application/json' https://api.carnivalmobile.com/v6/transactional/notifications/$group/stats","language":"curl"}]},"settings":"","results":{"codes":[{"name":"","code":"{\n  \"group\": \"coupon-codes\",\n  \"direct_opens\": 10,\n  \"indirect_opens\": 100,\n  \"notifications_sent\": 1000,\n  \"event_conversions\": {\n    \"my event\": 5\n  },\n  \"purchase_conversions\": [\n    {\n      \"name\": \"item_name_1\",\n      \"total_value\": 10,\n      \"count\": 1\n    },\n    {\n      \"name\": \"item_name_2\",\n      \"total_value\": 100,\n      \"count\": 2\n    }\n  ]\n}","language":"json","status":200},{"status":401,"name":"","code":"401 Unauthorized","language":"text"},{"language":"json","status":403,"code":"{\"error\":{\"reason\":\"unauthorized\"}}"}]},"auth":"required","params":[{"_id":"55ed121dc9d5b3350072ae9f","ref":"","in":"path","required":true,"desc":"Group identifier","default":"","type":"string","name":"group"}],"url":"/transactional/notifications/:group/stats"},"isReference":true,"order":25,"body":"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](https://marketing.carnival.io/docs/message-analytics).\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`group`\",\n    \"0-1\": \"String\",\n    \"0-2\": \"The transactional notification group\",\n    \"1-0\": \"`direct_opens`\",\n    \"1-1\": \"Integer\",\n    \"1-2\": \"How many times users opened the app as a result of tapping the push alert directly\",\n    \"2-0\": \"`indirect_opens`\",\n    \"2-1\": \"Integer\",\n    \"2-2\": \"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\",\n    \"3-0\": \"`event_conversions`\",\n    \"3-1\": \"Dictionary<String, Integer>\",\n    \"3-2\": \"A list of custom events where the key is a [custom event](doc:collecting-user-data) and the value is the number of occurrences of this event\",\n    \"4-0\": \"`purchase_conversions`\",\n    \"4-1\": \"Array[PurchaseItem<name: String, total_value: Integer, count: Integer>]\",\n    \"4-2\": \"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.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","excerpt":"Returns metrics for a given transactional notification group","slug":"stats-transactional-notifications","type":"endpoint","title":"Stats / Transactional Notifications"}

getStats / Transactional Notifications

Returns metrics for a given transactional notification group

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

group:
required
string
Group identifier

Examples


Result Format


Documentation

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](https://marketing.carnival.io/docs/message-analytics). [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Description", "0-0": "`group`", "0-1": "String", "0-2": "The transactional notification group", "1-0": "`direct_opens`", "1-1": "Integer", "1-2": "How many times users opened the app as a result of tapping the push alert directly", "2-0": "`indirect_opens`", "2-1": "Integer", "2-2": "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", "3-0": "`event_conversions`", "3-1": "Dictionary<String, Integer>", "3-2": "A list of custom events where the key is a [custom event](doc:collecting-user-data) and the value is the number of occurrences of this event", "4-0": "`purchase_conversions`", "4-1": "Array[PurchaseItem<name: String, total_value: Integer, count: Integer>]", "4-2": "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." }, "cols": 3, "rows": 5 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}