{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/transactional/notifications/:group/stats","auth":"required","method":"get","examples":{"codes":[{"language":"curl","code":"curl -X GET -u :$API_KEY -H 'Accept: application/json' https://api.carnivalmobile.com/v6/transactional/notifications/$group/stats","name":""}]},"settings":"","results":{"codes":[{"status":200,"language":"json","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}","name":""},{"language":"text","code":"401 Unauthorized","name":"","status":401},{"code":"{\"error\":{\"reason\":\"unauthorized\"}}","status":403,"language":"json"}]},"params":[{"name":"group","type":"string","default":"","desc":"Group identifier","required":true,"in":"path","ref":"","_id":"55ed121dc9d5b3350072ae9f"}]},"next":{"description":"","pages":[]},"title":"Stats / Transactional Notifications","type":"endpoint","slug":"stats-transactional-notifications","excerpt":"Returns metrics for a given transactional notification group","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://getstarted.sailthru.com/sailthru-mobile/analytics/push-notification-message-performance-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]","updates":[],"order":25,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e6156bf5e4a51006dcd8181","project":"55e67aaa9cc7c62b00c4a1ea","version":{"version":"1.5","version_clean":"1.5.0","codename":"ST Rebrand","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5e6156bf5e4a51006dcd8120","5e6156bf5e4a51006dcd8121","5e6156bf5e4a51006dcd8122","5e6156bf5e4a51006dcd8123","5e6156bf5e4a51006dcd8124","561c61b4ad272c0d00a892df","586c014c0abf1d0f000d04d4","58991d2ad207df0f0002186b","5e6156bf5e4a51006dcd8125","5e6156bf5e4a51006dcd8126","5af0fe494ca2730003cbc98a","5af0fe55ec80af0003804ca2","5e69868cbd5dcb006b35867b","5e6986ca2c6652006791b6e8"],"_id":"5e6156bf5e4a51006dcd818c","project":"55e67aaa9cc7c62b00c4a1ea","__v":2,"forked_from":"5b720760c44b7600034b7a08","createdAt":"2015-09-02T04:27:23.612Z","releaseDate":"2015-09-02T04:27:23.612Z"},"category":{"sync":{"isSync":false,"url":""},"pages":["5e6156bf5e4a51006dcd8138","55ed079b0d968e2100de8339","5e6156bf5e4a51006dcd8139","55ed0bb078319821005005cf","5e6156bf5e4a51006dcd813a","5e6156bf5e4a51006dcd813b","5e6156bf5e4a51006dcd813c","5e6156bf5e4a51006dcd813d","5e6156bf5e4a51006dcd813e","5e6156bf5e4a51006dcd813f","5e6156bf5e4a51006dcd8140","5e6156bf5e4a51006dcd8141","5e6156bf5e4a51006dcd8142","5e6156bf5e4a51006dcd8143","5e6156bf5e4a51006dcd8144","5e6156bf5e4a51006dcd8145","5b720760c44b7600034b79ce","5e6156bf5e4a51006dcd814d","5e6156bf5e4a51006dcd814e","5e6156bf5e4a51006dcd8156"],"title":"REST API","slug":"rest-api","order":5,"from_sync":false,"reference":true,"_id":"5e6156bf5e4a51006dcd8122","__v":20,"createdAt":"2015-09-02T04:30:21.948Z","project":"55e67aaa9cc7c62b00c4a1ea","version":"5e6156bf5e4a51006dcd818c"},"user":"56e5d6f82d90970e00af1b92","createdAt":"2019-01-30T00:37:10.399Z","__v":4,"parentDoc":null}

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://getstarted.sailthru.com/sailthru-mobile/analytics/push-notification-message-performance-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 }}