{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/audiences/:audience_id","auth":"required","examples":{"codes":[{"code":"curl -X GET -u :$API_KEY -H 'Accept: application/json' https://api.carnivalmobile.com/v6/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      \t\"test\": false,\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":11,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e6156bf5e4a51006dcd8145","githubsync":"","parentDoc":null,"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"},"editedParams2":true,"project":"55e67aaa9cc7c62b00c4a1ea","createdAt":"2015-09-07T04:58:35.601Z","editedParams":true,"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"},"user":"55d2bd8e2463351700f67dd7","__v":6}

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