Skip to main content

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

ParameterTypeRequiredDescription
startTimestringNoFilter events starting on or after this date (ISO 8601 format, e.g., 2026-01-01)
endTimestringNoFilter events starting on or before this date (ISO 8601 format, e.g., 2026-01-31)

​
Examples

GET /ads/exportClient                              # Default behavior (events before now)
GET /ads/exportClient?startTime=2026-01-01         # Events starting on/after Jan 1
GET /ads/exportClient?endTime=2026-01-31           # Events starting on/before Jan 31
GET /ads/exportClient?startTime=2026-01-01&endTime=2026-01-31  # Date range

​
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/ads/exportClient"
headers = {
    "x-api-key": "YOUR_API_KEY",
    "client": "YOUR_CLIENT_KEY"
}

# Optional: filter by date range
params = {
    "startTime": "2026-01-01",
    "endTime": "2026-01-31"
}

response = requests.get(url, headers=headers, params=params)
data = response.json()
print(data)

​
Response Schema

The API returns an array of ad delivery records. Each record contains detailed information about ad performance including impressions, video completion metrics, and hourly breakdowns.

​
Example Response

[
  {
    "campaignName": "Holiday_2024",
    "orderName": "Holiday Campaign - NFL Week 10",
    "orderNickName": "NFL_W10",
    "client": "ACME",
    "agency": "MediaCo",
    "cluster": "Sports",
    "event": "NFL: Cowboys vs Eagles",
    "network": "ESPN",
    "eventType": "SPORTS",
    "eventSubType": "NFL",
    "deliveryDate": "2025-11-10T18:00:00.000Z",
    "hourlyDelivery": [
      {
        "datetime": "2025-11-10T18:00:00.000Z",
        "impressions": 12500,
        "firstQuartile": 12400,
        "midpoint": 12300,
        "thirdQuartile": 12100,
        "complete": 11900,
        "creative": "Holiday_30s_v1"
      }
    ],
    "markets": "New York(501), Los Angeles(803)",
    "creative": "Holiday_30s_v1",
    "cpm": 45.0,
    "cost": 562.5,
    "impressionsDelivered": 12500,
    "firstQuartile": 12400,
    "midpoint": 12300,
    "thirdQuartile": 12100,
    "complete": 11900,
    "uid": "12345",
    "clientAgency": "",
    "lid": "67890",
    "pid": "11111",
    "oid": 1234,
    "aid": 5678
  }
]

​
Response Fields

FieldTypeDescription
campaignNamestringCampaign name
orderNamestringOrder name
orderNickNamestringOrder nickname / short name
clientstringClient name
agencystringAgency name
clusterstringOrder category/cluster (e.g., “Sports”, “Entertainment”)
eventstringEvent name where ad was delivered
networkstringNetwork/channel where ad ran
eventTypestringEvent type (e.g., “SPORTS”, “ENTERTAINMENT”)
eventSubTypestringEvent sub-category (e.g., “NFL”, “College Football”, “NBA”)
deliveryDatestring (ISO 8601)Event start datetime (UTC)
hourlyDeliveryarrayHourly breakdown of delivery metrics (see below for object structure)
marketsstringComma-separated list of targeted markets (DMA name with code, ZIP names, or “NATIONAL”)
creativestringCreative name(s) used, comma-separated if multiple
cpmnumberCPM rate
costnumberTotal cost calculated as cpm × (impressions / 1000)
impressionsDeliverednumberTotal impressions delivered
firstQuartilenumberCount of 25% video completions
midpointnumberCount of 50% video completions
thirdQuartilenumberCount of 75% video completions
completenumberCount of 100% video completions
uidstring | numberCampaign unique identifier (your campaign ID)
clientAgencystringAgency of Record (AOR) for the campaign
lidstring | numberLine/Order unique identifier (your order/line ID)
pidstringOrder PID identifier
oidnumberOur internal order ID
aidnumberOur internal activation ID

​
Hourly Delivery Object

Each item in the hourlyDelivery array contains granular hourly performance data:
FieldTypeDescription
datetimestring (ISO 8601)Hour timestamp
impressionsnumberImpressions delivered in this hour
firstQuartilenumber25% video completions in this hour
midpointnumber50% video completions in this hour
thirdQuartilenumber75% video completions in this hour
completenumber100% video completions in this hour
creativestringCreative name served in this hour

​
Notes

  • Only ads with delivered impressions (impressions > 0) are included
  • By default, only live/past events are included (events that have already started)
  • Use startTime and endTime query parameters to filter events by date range