Listener IDs (Campaign)

GET

/api/public/campaignshow/impression-listeners

Note: only prefix impressions are included.

Anonymized listener IDs for a campaign’s episodes, each with its number of listens.

This endpoint utilizes a task system.

Please read the description of Get status of file processing to understand how it works.

Note: You can only pull Listener IDs from the last 90 days.

At least one of the following query parameters is required:

id
external_lookup_name
placed_name
external_id

Listener IDs (Campaign)

const url = 'https://backend.podscribe.ai/api/public/campaignshow/impression-listeners?advertiser=example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

import requests

url = "https://backend.podscribe.ai/api/public/campaignshow/impression-listeners"

querystring = {"advertiser":"example"}

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())

curl --request GET \
  --url 'https://backend.podscribe.ai/api/public/campaignshow/impression-listeners?advertiser=example' \
  --header 'Authorization: Bearer <token>'

Query Parameters

string<uuid>

The campaign show id to get data for

external_lookup_name

string

The campaign show external_lookup_name to get data for

placed_name

string

The campaign show placed_name to get data for

external_id

string

The campaign show external_id to get data for

advertiser

required

string

The advertiser to get data for

Response Body

application/json

ID of the file processing task.

string<uuid>

status

Task status: pending, done or failed.

pending done failed

url

Link to download the result file. Returned once the file is ready.

string<uri>

Response example

{
  "status": "pending"
}

Result file

Field	Type	Example	Description
User Id	string	abcd1234efgh	An anonymized listener identifier.
Frequency	number	4	Number of qualifying listens for that listener.