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.

​
Example Request

GET /campaigns/exportClientReachFrequencyReport

​
Example API Usage

Here are examples of how to fetch Reach and Frequency data from the Addressable.tv API endpoint in different programming languages: 
import requests

url = "https://api.addressable.tv/campaigns/exportClientReachFrequencyReport"
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 campaign-level Reach and Frequency records.

​
Example Response

[
  {
    "campaignId": 1234,
    "campaignName": "Holiday Campaign 2024",
    "status": "ACTIVE",
    "reach": 84231,
    "impressions": 194500,
    "frequency": 2.31,
    "clientCampaignId": "CAMP-2024-001",
    "clientAgency": ""
  }
]

​
Response Fields

FieldTypeDescription
campaignIdnumberInternal campaign ID
campaignNamestringCampaign name
statusstringCampaign status
reachnumberDistinct users reached
impressionsnumberTotal delivered impressions
frequencynumberAverage frequency (impressions / reach), rounded to 2 decimals
clientCampaignIdstringYour campaign identifier when available
clientAgencystringAgency of Record (AOR) for the campaign when available

​
Notes

  • The report currently uses a rolling ~45-day lookback window.
  • Frequency is derived from aggregated impressions and reach.
  • If reach is 0, frequency is returned as 0.