{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/audiences/:audience_id","auth":"required","examples":{"codes":[{"code":"curl -X GET -u :API_KEY https://api.carnivalmobile.com/v5/audiences/:audience_id","name":"","language":"curl"}]},"method":"get","params":[{"name":"audience_id","type":"string","default":"","desc":"The ID of the Audience","required":false,"in":"path","ref":"","_id":"55ed197bc9d5b3350072aec1"}],"results":{"codes":[{"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}","language":"json","status":200,"name":""},{"language":"json","status":401,"name":"","code":"{\n  \"error\":\"unauthorized\"\n}"},{"code":"{\n  \"error\":\"your api client does not have the correct roles\"\n}","language":"json","status":403}]},"settings":"","apiSetting":null},"next":{"description":"","pages":[]},"title":"Audience","type":"endpoint","slug":"audience","excerpt":"Returns details about a given Audience","body":"","updates":[],"order":10,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5b1f2cbdfd653400031d8d66","githubsync":"","parentDoc":null,"category":{"sync":{"isSync":false,"url":""},"pages":["5b1f2cbdfd653400031d8d59","55ed079b0d968e2100de8339","5b1f2cbdfd653400031d8d5a","55ed0bb078319821005005cf","5b1f2cbdfd653400031d8d5b","5b1f2cbdfd653400031d8d5c","5b1f2cbdfd653400031d8d5d","5b1f2cbdfd653400031d8d5e","5b1f2cbdfd653400031d8d5f","5b1f2cbdfd653400031d8d60","5b1f2cbdfd653400031d8d61","5b1f2cbdfd653400031d8d62","5b1f2cbdfd653400031d8d63","5b1f2cbdfd653400031d8d64","5b1f2cbdfd653400031d8d65","5b1f2cbdfd653400031d8d66","5b1f2cbdfd653400031d8d67","5b1f2cbdfd653400031d8d6f","5b1f2cbdfd653400031d8d70","5b1f2cbdfd653400031d8d78"],"title":"REST API","slug":"rest-api","order":5,"from_sync":false,"reference":true,"_id":"5b1f2cbdfd653400031d8d44","__v":20,"createdAt":"2015-09-02T04:30:21.948Z","project":"55e67aaa9cc7c62b00c4a1ea","version":"5b1f2cbdfd653400031d8d9f"},"editedParams2":true,"project":"55e67aaa9cc7c62b00c4a1ea","createdAt":"2015-09-07T04:58:35.601Z","editedParams":true,"version":{"version":"1.3","version_clean":"1.3.0","codename":"rebrand","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5b1f2cbdfd653400031d8d42","5b1f2cbdfd653400031d8d43","5b1f2cbdfd653400031d8d44","5b1f2cbdfd653400031d8d45","5b1f2cbdfd653400031d8d46","561c61b4ad272c0d00a892df","586c014c0abf1d0f000d04d4","58991d2ad207df0f0002186b","5b1f2cbdfd653400031d8d47","5b1f2cbdfd653400031d8d48","5af0fe494ca2730003cbc98a","5af0fe55ec80af0003804ca2"],"_id":"5b1f2cbdfd653400031d8d9f","project":"55e67aaa9cc7c62b00c4a1ea","__v":0,"forked_from":"55e67aab9cc7c62b00c4a1ed","createdAt":"2015-09-02T04:27:23.612Z","releaseDate":"2015-09-02T04:27:23.612Z"},"user":"55d2bd8e2463351700f67dd7","__v":1}

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