Documentation Index
Fetch the complete documentation index at: https://docs.addressable.tv/llms.txt
Use this file to discover all available pages before exploring further.
Query Parameters
| Parameter | Type | Required | Description |
|---|
type | string | No | Set to broadcast to aggregate by broadcast month instead of calendar month |
Examples
GET /campaigns/exportClientDeviceReport # Default (calendar month)
GET /campaigns/exportClientDeviceReport?type=broadcast # Broadcast month
Example API Usage
Here are examples of how to fetch data from the Addressable.tv API endpoint in different programming languages:
import requests
url = "https://api.addressable.tv/campaigns/exportClientDeviceReport"
headers = {
"x-api-key": "YOUR_API_KEY",
"client": "YOUR_CLIENT_KEY"
}
# Optional: use broadcast month aggregation
params = {"type": "broadcast"}
response = requests.get(url, headers=headers, params=params)
data = response.json()
print(data)
Response Schema
The API returns an array of device delivery records, aggregated by campaign, month, and device type.
Example Response
[
{
"campaignName": "Holiday Campaign 2024",
"status": "ACTIVE",
"advertiser": "Acme Corporation",
"client": "ACME",
"month": "2025-10",
"device": "CTV",
"impressions": 125000,
"uid": "12345",
"clientAgency": ""
},
{
"campaignName": "Holiday Campaign 2024",
"status": "ACTIVE",
"advertiser": "Acme Corporation",
"client": "ACME",
"month": "2025-10",
"device": "Mobile",
"impressions": 45000,
"uid": "12345",
"clientAgency": ""
},
{
"campaignName": "Holiday Campaign 2024",
"status": "ACTIVE",
"advertiser": "Acme Corporation",
"client": "ACME",
"month": "2025-11",
"device": "CTV",
"impressions": 180000,
"uid": "12345",
"clientAgency": ""
}
]
Response Fields
| Field | Type | Description |
|---|
campaignName | string | Campaign name |
status | string | Campaign status: ACTIVE, COMPLETE, PENDING, PAUSED, or CANCELLED |
advertiser | string | Advertiser name |
client | string | Client name |
month | string | Month in YYYY-MM format |
device | string | Device type (see below) |
impressions | number | Total impressions for this device/month combination |
uid | string | number | Campaign unique identifier (your campaign ID) |
clientAgency | string | Agency of Record (AOR) for the campaign |
Device Types
| Device | Description |
|---|
ROKU | Roku devices and Roku TVs |
SAMSUNG | Samsung Smart TVs |
AMAZON | Amazon Fire TV devices |
APPLE TV | Apple TV devices |
VIZIO | Vizio Smart TVs |
LG | LG Smart TVs (includes WebOS) |
ANDROID TV | Android TV devices (includes Google TV) |
INSIGNIA | Insignia Smart TVs |
TOSHIBA | Toshiba Smart TVs |
HISENSE | Hisense Smart TVs |
DIRECTV | DirecTV streaming devices |
SONY | Sony Smart TVs |
ONN | Onn streaming devices (Walmart brand) |
TCL | TCL Smart TVs |
PHILIPS | Philips Smart TVs |
OTHER | Other CTV devices not matching the above categories |
Notes
- Data is aggregated by campaign, month, and device type
- Only campaigns with device statistics are included
- Each row represents a unique campaign + month + device combination
- Use
?type=broadcast to aggregate by broadcast month instead of calendar month
