Get Multiple Audiences

Retrieves one or more audiences or superaudiences.

Request

GET /audiences?page=Page Number&page_size=Items Per Page

Request query string parameters:

Pass the following optional request query string parameters:

Response

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

items List

The items list describes each audience configuration via the following properties:

Sample Request/Response

Call the get_multiple_audiences module (Python 3) to retrieve multiple audiences. This module imports names from the api_auth module.

import json, requests
from api_auth import APICredentials, APIParams

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

    def run(self):
        self._get_multiple_audiences()

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

        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',
	'@type': 'Collection',
	'items': [{
			'@id': '/api/v4/audiences/e1fa7c93edda4541937899ad032b9051',
			'@type': 'Audience',
			'id': 'e1fa7c93edda4541937899ad032b9051',
			'created': '2021-06-30T17:57:51.765Z',
			'owner': 'abc123def456ghi789jkl012mno345pq',
			'match_type': 'ANY',
			'external_id': '',
			'country_codes': [],
			'dma_codes': [],
			'desc': 'Beverly Hills',
			'devices': [],
			'ip_networks': [],
			'zip_codes': ['90503'],
			'sub_audiences': [],
			'type': 'Single'
		}, {
			'@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'
		}
	],
	'total_items': 2
}