{"_id":"560375cd90ee490d004403da","__v":4,"category":{"_id":"55e76b8196131b2f00bf4b72","pages":["55e8b2c13fef5017000dbd9a","55e8b365f0f1850d00d24a5b","55f88ebd5840d119004346bf","55f8ab55c449610d002daf87","5603759a8d58900d0051e9ee","560375cd90ee490d004403da","5633b5ebc49a7c19001fd091","567353ae47f7010d005bfdc9"],"project":"5429beef1163360800ed31fa","__v":8,"version":"5429beef1163360800ed31fd","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-02T21:34:57.232Z","from_sync":false,"order":2,"slug":"apis","title":"Integrating with APIs"},"editedParams":true,"project":"5429beef1163360800ed31fa","parentDoc":null,"editedParams2":true,"version":{"_id":"5429beef1163360800ed31fd","__v":21,"project":"5429beef1163360800ed31fa","createdAt":"2014-09-29T20:19:59.904Z","releaseDate":"2014-09-29T20:19:59.904Z","categories":["5429beef1163360800ed31fe","55e74e1f5d36b32b002563fa","55e7500a73169617001f2e86","55e76b8196131b2f00bf4b72","55e89569cdbb8a350096df9c","55f8935eb089b71700a8364e","55f8a67d3bb4bb0d0022d093","55f9dbefc7ef770d00d9bf6d","5601c21a22ecf60d002b27b3","5601c21ff12aee0d001bb06e","5601c2256c7b610d00280db5","5601c22c22ecf60d002b27b4","5603738d0c78b00d0039af47","5626f70bfcbbc621004ebf52","566f7a1ae144ab0d00e9732f","566f85ca7820960d00c3b93d","56708ce43a32d20d00c45cbf","56708d436995210d003aad8e","5736471abe10a9200030732c","57a82c7aff9bd30e00a6f1c1","591b8500e3992319007190f4"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"user":"5429becb1163360800ed31f8","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-24T04:02:21.076Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"code":"","language":"text"}]},"settings":"57762cbbd44a3e0e00329d68","examples":{"codes":[{"name":"","code":"http://bevo.adsnative.com/ca?sid=[SESSION_ID]&action_name=like&action_value=1","language":"curl"}]},"method":"get","auth":"required","params":[{"_id":"5603762590ee490d004403dd","ref":"","in":"query","required":true,"desc":"Session id for ad","default":"","type":"string","name":"sid"},{"_id":"5603762590ee490d004403dc","ref":"","in":"query","required":true,"desc":"Unique action name defined and triggered by user actions on your inventory. For example, User Likes.","default":"","type":"string","name":"action_name"},{"_id":"560376a4e5102a0d0070f833","ref":"","in":"query","required":false,"desc":"Value to aggregate in your reports","default":"","type":"int","name":"action_value"}],"url":"/ca"},"isReference":true,"order":4,"body":"Custom actions are mainly used to track custom metrics unique to your inventory.  Here are few that some of our customers use - \n\n## Examples ##\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Like\",\n    \"1-0\": \"Share\",\n    \"3-0\": \"Comment\",\n    \"2-0\": \"Hover\",\n    \"4-0\": \"Expand\",\n    \"5-0\": \"Collapse\",\n    \"6-0\": \"Facebook Share\",\n    \"7-0\": \"Twitter Share\",\n    \"8-0\": \"WhatsApp Share\",\n    \"9-0\": \"Pinterest Share\",\n    \"10-0\": \"Text Share\",\n    \"11-0\": \"LinkedIn Share\",\n    \"12-0\": \"Email\",\n    \"13-0\": \"Play\",\n    \"14-0\": \"Pause\",\n    \"15-0\": \"Resume\",\n    \"16-0\": \"Skip\",\n    \"17-0\": \"Time spent on a page\"\n  },\n  \"cols\": 1,\n  \"rows\": 18\n}\n[/block]","excerpt":"Custom actions API is used to track any custom actions or events when user interacts with the ad.  \n\nYou can define any number of custom actions, and tracking events. Reports for all these custom actions, and tracking events will show up in your reporting dashboard.","slug":"ca","type":"endpoint","title":"Custom Actions API"}

getCustom Actions API

Custom actions API is used to track any custom actions or events when user interacts with the ad. You can define any number of custom actions, and tracking events. Reports for all these custom actions, and tracking events will show up in your reporting dashboard.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

sid:
required
string
Session id for ad
action_name:
required
string
Unique action name defined and triggered by user actions on your inventory. For example, User Likes.
action_value:
integer
Value to aggregate in your reports

Examples


Documentation

Custom actions are mainly used to track custom metrics unique to your inventory. Here are few that some of our customers use - ## Examples ## [block:parameters] { "data": { "0-0": "Like", "1-0": "Share", "3-0": "Comment", "2-0": "Hover", "4-0": "Expand", "5-0": "Collapse", "6-0": "Facebook Share", "7-0": "Twitter Share", "8-0": "WhatsApp Share", "9-0": "Pinterest Share", "10-0": "Text Share", "11-0": "LinkedIn Share", "12-0": "Email", "13-0": "Play", "14-0": "Pause", "15-0": "Resume", "16-0": "Skip", "17-0": "Time spent on a page" }, "cols": 1, "rows": 18 } [/block]