Get Audiences API

api keys customer access to cadent apis requires configuration of an api key cadent uses an api key to authenticate and authorize requests for external api’s the api key is a unique identifier issued to each customer account it acts as a credential that allows users or applications to access api endpoints securely when making requests to audience list api, include your api key in the http request header x api key for example curl h "x api key your api key" x get https //api cadent tv/v1/as/audiences { "name" "get audiences api", "method" "get", "url" "https //api cadent tv/v1/as/audiences", "description" "the request returns a list of audiences available to the requested account group id the get audiences api includes all audiences belonging to the request group, as well as all audiences shared with request group, if any \n\nthe response includes audience details such as id, name, createddt, modifieddt, cpm, counts and the link to audience page \n", "tab" "examples", "examples" { "languages" \[ { "id" "0dbc8 qhfcqyt3nrjfbkn", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\n\nvar raw = json stringify({\n \\"id\\" \\"string\\"\n});\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"https //api cakes com\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" } ], "selectedlanguageid" "0dbc8 qhfcqyt3nrjfbkn" }, "results" { "languages" \[ { "id" "xivwufmdzwq8aikwmyiws", "language" "200", "code" "{\n \\"name\\" \\"audience name\\",\n}", "customlabel" "" }, { "id" "es8gmuxxispp3gbcsppie", "language" "404", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n}", "customlabel" "" } ], "selectedlanguageid" "xivwufmdzwq8aikwmyiws" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "includeshared", "kind" "optional", "type" "string", "description" "used to filter an audience shared by specified group with current group this parameter will work when includeshared is true", "" "used to filter an audience shared by specified group with current group this parameter will work when includeshared is true" }, { "name" "sharedfromgroupids", "kind" "optional", "type" "string", "description" "used to filter an audience shared by specified group with current group this parameter will work when includeshared is true", "" "used to filter an audience shared by specified group with current group this parameter will work when includeshared is true" }, { "name" "advertiserids", "kind" "optional", "type" "string", "description" "aab advertiser master ids (36 character guid) used to filter restricted audiences", "" "aab advertiser master ids (36 character guid) used to filter restricted audiences" }, { "name" "withsegments", "kind" "optional", "type" "string", "description" "determines whether to include segment details or not default is false ", "" "determines whether to include segment details or not default is false " }, { "name" "withdeployments", "kind" "optional", "type" "string", "description" "deployments will be filtered based on delivery partnerid for audiences if it is specified otherwise, all active deployments will be returned this parameter will work when withdeployments is true \ntrue displays all the deployments and statuses for audiences value should be either true or false", "" "deployments will be filtered based on delivery partnerid for audiences if it is specified otherwise, all active deployments will be returned this parameter will work when withdeployments is true \ntrue displays all the deployments and statuses for audiences value should be either true or false" } ], "headerparameters" \[], "bodydataparameters" \[ { "name" "status", "kind" "optional", "type" "string", "description" "", "" "status" }, { "name" "start", "kind" "optional", "type" "string", "description" "", "" "start" }, { "name" "size", "kind" "optional", "type" "string", "description" "", "" "size" }, { "name" "withsegments", "kind" "optional", "type" "string", "description" "", "" "withsegments" }, { "name" "includeshared", "kind" "optional", "type" "string", "description" "", "" "includeshared" }, { "name" "sharedfromgroupids", "kind" "optional", "type" "string", "description" "", "" "sharedfromgroupids" }, { "name" "advertiserids", "kind" "optional", "type" "string", "description" "", "" "advertiserids" }, { "name" "withdeployments", "kind" "optional", "type" "string", "description" "", "" "withdeployments" }, { "name" "deliverpartnerid", "kind" "optional", "type" "string", "description" "", "" "deliverpartnerid" } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "hastryitout" true, "response" \[ { "name" "status", "kind" "optional", "type" "string", "description" "" }, { "name" "start", "kind" "optional", "type" "string", "description" "", "children" \[] }, { "name" "size", "kind" "optional", "type" "string", "description" "", "children" \[] }, { "name" "withsegments", "kind" "optional", "type" "string", "description" "", "children" \[] }, { "name" " includeshared", "kind" "optional", "type" "string", "description" "", "children" \[] }, { "name" "sharedfromgroupids", "kind" "optional", "type" "string", "description" "", "children" \[] }, { "name" "advertiserids", "kind" "optional", "type" "string", "description" "", "children" \[] }, { "name" "withdeployments", "kind" "optional", "type" "string", "description" "", "children" \[] }, { "name" "deliverpartnerid", "kind" "optional", "type" "string", "description" "", "children" \[] } ], "autogeneratedanchorslug" "get audiences api", "legacyhash" "vpobw xtfa16eemzeptzi" } get audience example } ] } "issharedaudience" false "status" "active", "lastprocesseddt" "10/04/2021 12 22", "url" "https //api cadent tv/v1/as/audiences/#/editaudiencebuilder/6842", "cpm" "0 00", "modifieddt" "10/04/2021 12 22", "createddt" "10/04/2021 12 21", }, "maid" 342820 "hhid" 69772, "ip" 70376, "counts" { "name" "test automation1 ipsha512 1155700970", "id" 6842, { }, "issharedaudience" false "status" "active", "lastprocesseddt" "10/04/2021 12 22", "url" "https //api cadent tv/v1/as/audiences/#/editaudiencebuilder/6843", "cpm" "0 00", "modifieddt" "10/04/2021 12 22", "createddt" "10/04/2021 12 21", }, "maid" 95 "hhid" 220, "ip" 26, "counts" { "name" "test automation1 email 1970396748", "id" 6843, { "audiences" \[ "transaction id" "24dbb13d 7f75 456b bfff adb8b1df7428", "success"\ true, { get audiences example (withsegments= true) } ] } } ] "5312" "demo" \[ "segments" { "issharedaudience" false, "status" "active", "lastprocesseddt" "10/04/2021 12 22", "url" "https //api cadent tv/v1/as/audiences/#/editaudiencebuilder/6842", "cpm" "0 00", "modifieddt" "10/04/2021 12 22", "createddt" "10/04/2021 12 21", }, "maid" 342820 "hhid" 69772, "ip" 70376, "counts" { "name" "test automation1 ipsha512 1155700970", "id" 6842, { }, } ] "test001 zip11 sha1" "demo" \[ "segments" { "issharedaudience" false, "status" "active", "lastprocesseddt" "10/04/2021 12 22", "url" "https //api cadent tv/v1/as/audiences/#/editaudiencebuilder/6843", "cpm" "0 00", "modifieddt" "10/04/2021 12 22", "createddt" "10/04/2021 12 21", }, "maid" 95 "hhid" 220, "ip" 26, "counts" { "name" "test automation1 email 1970396748", "id" 6843, { "audiences" \[ "transaction id" "24dbb13d 7f75 456b bfff adb8b1df7428", "success"\ true, { get audiences example (includeshared=true) } "transaction id" "beb6293c be7f 450d 8af1 49c28dfb1096" ], } "issharedaudience" true }, ] "commerce clickers by ziff daivs" "automotive", "black friday", "all gaming & video games", \[ "qa" { "segments" "status" "active", "lastprocesseddt" "10/13/2021 16 51", "url" "https //api cadent tv/v1/as/audiences/#/editaudiencebuilder/6974", "cpm" "6 00", "modifieddt" "10/13/2021 16 51", "createddt" "10/13/2021 16 50", }, "maid" 2173 "hhid" 2032, "ip" 23136, { "counts" "name" "audience totestcontrol", "id" 6974, { }, "issharedaudience" false }, ] "automotive" "zdcore seg bf category baby kids", \[ "demo" { "segments" "status" "active", "lastprocesseddt" "10/14/2021 09 14", "url" "https //api cadent tv/v1/as/audiences/#/editaudiencebuilder/6997", "cpm" "0 00", "modifieddt" "10/26/2021 11 59", "createddt" "10/14/2021 09 14", }, "maid" 179 "hhid" 754, "ip" 754, { "counts" "name" "copy of test dupl name12", "id" 6997, { \[ "audiences" "success" true, { get audiences with advertiser ids, deployments and delivery partner id } ] } ] } "lastdeployed" "10/15/2021 06 27" "jobstatus" "done", "status" "active", "deliverypartnername" "adth", "deliverypartnerid" 45, "name" "test1 audience deployment", "id" 132, { "deployments" \[ "issharedaudience" false, "status" "active", "lastprocesseddt" "10/04/2021 12 22", "url" "https //api cadent tv/v1/as/audiences/#/editaudiencebuilder/6842", "cpm" "0 00", "modifieddt" "10/04/2021 12 22", "createddt" "10/04/2021 12 21", }, "maid" 342820 "hhid" 69772, "ip" 70376, "counts" { "name" "test automation1 ipsha512 1155700970", "id" 6842, { }, ] } "enddate" "01/17/2025" "lastdeployed" "10/15/2021 06 27", "jobstatus" "failed", "status" "active", "deliverypartnername" "adth", "deliverypartnerid" 45, "name" "test deployment", "id" 33, { "deployments" \[ "issharedaudience" false, "status" "active", "lastprocesseddt" "10/04/2021 12 22", "url" "https //api cadent tv/v1/as/audiences/#/editaudiencebuilder/6843", "cpm" "0 00" "modifieddt" "10/04/2021 12 22", "createddt" "10/04/2021 12 21", }, "maid" 95 "hhid" 220, "ip" 26, "counts" { "name" "test automation1 email 1970396748", "id" 6843, { "audiences" \[ "transaction id" "24dbb13d 7f75 456b bfff adb8b1df7428", "success"\ true, {