Retrieves an audience or a superaudience.

Request

Request syntax:

GET /audiences/Audience ID

Define the following variable when submitting the above request:

VariableA variable represents a value that must be replaced. A variable consists of either a URL segment (e.g., "0001" in /0001/) or a query string value (e.g., "3" in mediaTypes=3).	Description
Audience ID Required	Identifies an audience by its system-defined or external ID. Use the Get Multiple Audiences endpoint to retrieve a list of audiences/superaudience and their IDs.

Response

A successful request returns a 200 OK response that contains the following properties:

Name	Data Type	Description
@id	String	Indicates the relative path to an endpoint that returns this audience or superaudience.
@type	String	Returns Audience.
country_codes	List of string values	Audience only Indicates the set of countries associated with this audience. Each value identifies a country by its two character country code (ISO 3166). View a list of country codes.
created	String	Indicates the timestamp (UTC) at which the audience or superaudience was created. Syntax (ISO 8601): YYYY-MM-DDThh:mm:ss.sssZ
desc	String	Indicates the name of the audience or superaudience.
devices	List of string values	Audience only Indicates the set of devices associated with this audience. Each value identifies a device by its name or description. Each value in this List will be compared against the value defined for the repl.cbdevice playback URL parameter.
dma_codes	List of string values	Audience only Indicates the set of designated market areas (DMA) associated with this audience. Each value identifies a United States DMS by its ID. Request Nielsen DMA data.
external_id	String	Indicates the external ID associated with this audience or superaudience.
id	String	Identifies this audience or superaudience by its system-defined ID.
ip_networks	List of string values	Audience only Indicates the set of IP addresses or subnets associated with this audience. Each value identifies either an IP address or IP network.
match_type	String	Determines the set of criteria that will be required to qualify a viewer for this audience or superaudience. Valid values are: ALL	ANY	NONE Learn more.
owner	String	Indicates the system-defined ID for the user that owns this audience or superaudience.
sub_audiences	List of string values	Superaudience only Indicates the set of audiences associated with this superaudience. Each value identifies an audience by its system-defined ID. Learn more.
type	String	Indicates whether this configuration is an audience or a superaudience. Valid values are: Single	Multiple Learn more.
zip_codes	List of string values	Audience only Indicates the set of United States zip codes associated with this audience. Each value identifies a zip code.

Sample Request/Response

The code below (Python 3) shows how to retrieve a specific audience.

This code imports names from the api_auth module for V4 APIs (see below).

import json
import requests
from api_auth import APICredentials, APIParams

class GetReplaceMeREPLACEME:
    def __init__(self):

import json, requests
from api_auth import APICredentials, APIParams
audience_id = '02ed9f65570746528e7b3d0628960025' # Replace with the ID for the desired audience.

class Audience:
    def __init__(self):
        self.host = "https://services.uplynk.com"

    def run(self):
        self._get_audience()

    def _get_audience(self):
        url = "{}{}{}".format(self.host, "/api/v4/audiences/", audience_id)

        headers = {'Content-Type': 'application/json'}

        response = requests.get(
            url, params=APIParams(APICredentials()).get_params({}), headers=headers
        )

        print(response.json())

Audience().run()

Response:

{
	'@id': '/api/v4/audiences/abc11672b78c4d03bf4756ec3ea46a22',
	'@type': 'Audience',
	'created': '2021-06-30T22:32:09.362Z',
	'id': 'cc1c1672b78c4d03bf4756ec3ea46a45',
	'owner': 'abc123def456ghi789jkl012mno345pq',
	'match_type': 'ANY',
	'external_id': 'NorthAmerica',
	'country_codes': ['CA', 'MX', 'US'],
	'dma_codes': [],
	'desc': 'My New audience',
	'devices': [],
	'ip_networks': [],
	'zip_codes': [],
	'sub_audiences': [],
	'type': 'Single'
}