{"_id":"575ff4b24715f61700ae84e0","editedParams2":true,"__v":7,"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"},"user":"563b4a20dfa1282b000dd262","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"},"editedParams":true,"parentDoc":null,"project":"5429beef1163360800ed31fa","updates":["581e20f91d96c40f004e9cba"],"next":{"pages":[],"description":""},"createdAt":"2016-06-14T12:12:34.372Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"","name":""}]},"settings":"59c57f5ceb1ccd001c8e95ef","examples":{"codes":[{"language":"text","code":"https://bevo.adsnative.com/seg.gif?segment_token=ZW6WXK9T&uuid=AEBE52E7-03EE-455A-B3C4-E57283966239&utype=idfa&action=add"}]},"method":"get","auth":"required","params":[{"_id":"57762f52ece8a00e00a15c3e","ref":"","in":"query","required":true,"desc":"Unique ID representing segment, it is listed under segments page on Console","default":"","type":"string","name":"segment_token"},{"_id":"57762f52ece8a00e00a15c3d","ref":"","in":"query","required":false,"desc":"Unique user id, refer to utype for accepted uuid types","default":"","type":"string","name":"uuid"},{"_id":"57762f52ece8a00e00a15c3c","ref":"","in":"query","required":false,"desc":"Accepted values are idfa | gaid | cookie | pub_uuid","default":"cookie","type":"string","name":"utype"},{"_id":"57762f52ece8a00e00a15c3b","ref":"","in":"query","required":false,"desc":"Accepted values are add | delete","default":"add","type":"string","name":"action"}],"url":"/seg.gif"},"isReference":true,"order":8,"body":"You can capture audience segments by using the API above. It is a 1x1 pixel that you can fire from your server (or on your client side if you prefer) when you want to add a user to an existing audience segment.\n\nIf you have a mobile website or desktop web property and wish to capture audience segments through JavaScript instead of API, please refer to this [documentation](http://dev.adsnative.com/v1.0/docs/audience-segments-js).\n\nFor instructions on creating and managing audience segments on Console, please refer to this [documentation](http://dev.adsnative.com/v1.0/docs/profile-db).","excerpt":"API for publishers to build Audience Segments (ProfileDB) using AdsNative platform","slug":"audience-segments-api","type":"endpoint","title":"Audience Segments API"}

getAudience Segments API

API for publishers to build Audience Segments (ProfileDB) using AdsNative platform

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

segment_token:
required
string
Unique ID representing segment, it is listed under segments page on Console
uuid:
string
Unique user id, refer to utype for accepted uuid types
utype:
stringcookie
Accepted values are idfa | gaid | cookie | pub_uuid
action:
stringadd
Accepted values are add | delete

Examples


Documentation

You can capture audience segments by using the API above. It is a 1x1 pixel that you can fire from your server (or on your client side if you prefer) when you want to add a user to an existing audience segment. If you have a mobile website or desktop web property and wish to capture audience segments through JavaScript instead of API, please refer to this [documentation](http://dev.adsnative.com/v1.0/docs/audience-segments-js). For instructions on creating and managing audience segments on Console, please refer to this [documentation](http://dev.adsnative.com/v1.0/docs/profile-db).

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 }}