{"_id":"5b720760c44b7600034b79cd","githubsync":"","parentDoc":null,"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"},"editedParams2":true,"project":"55e67aaa9cc7c62b00c4a1ea","editedParams":true,"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"},"user":"55d2bd8e2463351700f67dd7","__v":2,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-07T04:58:35.601Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","name":"","code":"curl -X GET -u :API_KEY https://api.carnivalmobile.com/v6/audiences/:audience_id"}]},"method":"get","results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n    \"audience\": {\n        \"name\": \"Wellington CBD\",\n        \"created_at\": \"2014-10-23T23:13:32.747Z\",\n        \"updated_at\": \"2015-05-04T03:22:16.501Z\",\n        \"id\": \"ABC\",\n        \"device_count\": 10\n    }\n}"},{"code":"{\n  \"error\":\"unauthorized\"\n}","name":"","status":401,"language":"json"},{"status":403,"language":"json","code":"{\n  \"error\":\"your api client does not have the correct roles\"\n}"}]},"settings":"","apiSetting":null,"auth":"required","params":[{"_id":"55ed197bc9d5b3350072aec1","ref":"","in":"path","required":false,"desc":"The ID of the Audience","default":"","type":"string","name":"audience_id"}],"url":"/audiences/:audience_id"},"isReference":true,"order":10,"body":"","excerpt":"Returns details about a given Audience","slug":"audience","type":"endpoint","title":"Audience"}

getAudience

Returns details about a given Audience

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

audience_id:
string
The ID of the Audience

Examples


Result Format


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