Skip to main content
GET
Report spend per program

Authorizations

x-api-key
string
header
required

API key created in Dashboard → Settings → Developer

Query Parameters

scope
enum<string>
default:company

Choose the data scope. company (default) limits results to the API key company's data. agency includes the parent agency and its linked brands. scope=agency requires a parent agency key; other keys receive 403.

Available options:
company,
agency
page
integer
default:1

Pagination page number

Required range: x >= 1
limit
integer
default:25

Programs to return per page

Required range: 1 <= x <= 100
programId
string<uuid>

Narrow the report to one program

fromDate
string<date>

Count delivery on or after this New York day (YYYY-MM-DD)

toDate
string<date>

Count delivery on or before this New York day (YYYY-MM-DD)

Response

Program spend returned successfully

data
object[]
page
integer
limit
integer
total
integer
totalPages
integer
fromDate
string | null
toDate
string | null
timeZone
enum<string>

Time zone of the date range and of each day

Available options:
America/New_York
summary
object