Skip to main content

​
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"
}

response = requests.get(url, headers=headers)
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"
  },
  {
    "campaignName": "Holiday Campaign 2024",
    "status": "ACTIVE",
    "advertiser": "Acme Corporation",
    "client": "ACME",
    "month": "2025-10",
    "device": "Mobile",
    "impressions": 45000,
    "uid": "12345"
  },
  {
    "campaignName": "Holiday Campaign 2024",
    "status": "ACTIVE",
    "advertiser": "Acme Corporation",
    "client": "ACME",
    "month": "2025-11",
    "device": "CTV",
    "impressions": 180000,
    "uid": "12345"
  }
]

​
Response Fields

FieldTypeDescription
campaignNamestringCampaign name
statusstringCampaign status: ACTIVE, COMPLETE, PENDING, PAUSED, or CANCELLED
advertiserstringAdvertiser name
clientstringClient name
monthstringMonth in YYYY-MM format
devicestringDevice type (see below)
impressionsnumberTotal impressions for this device/month combination
uidstring | numberCampaign unique identifier (your campaign ID)

​
Device Types

DeviceDescription
ROKURoku devices and Roku TVs
SAMSUNGSamsung Smart TVs
AMAZONAmazon Fire TV devices
APPLE TVApple TV devices
VIZIOVizio Smart TVs
LGLG Smart TVs (includes WebOS)
ANDROID TVAndroid TV devices (includes Google TV)
INSIGNIAInsignia Smart TVs
TOSHIBAToshiba Smart TVs
HISENSEHisense Smart TVs
DIRECTVDirecTV streaming devices
SONYSony Smart TVs
ONNOnn streaming devices (Walmart brand)
TCLTCL Smart TVs
PHILIPSPhilips Smart TVs
OTHEROther 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