Skip to main content
PUT
/
v1
/
report
/
{id}
{
  "results": {
    "id": 19972,
    "title": null,
    "created_by": 564,
    "organisation_id": 3,
    "fields": [
      "date",
      "publisher",
      "uid",
      "net_revenue",
      "gross_revenue"
    ],
    "date_range": "seven_days",
    "custom_date": null,
    "filters": {
      "account_name": {
        "matches": [],
        "type": "include"
      },
      "account_owner": {
        "matches": [],
        "type": "include"
      },
      "channel": {
        "matches": [],
        "type": "include"
      },
      "config_id": {
        "matches": [],
        "type": "include"
      },
      "creative_size": {
        "matches": [],
        "type": "include"
      },
      "device": {
        "matches": [],
        "type": "include"
      },
      "environment": {
        "matches": [],
        "type": "include"
      },
      "geo": {
        "matches": [],
        "type": "include"
      },
      "line_item": {
        "matches": [],
        "type": "include"
      },
      "oid": {
        "matches": [],
        "type": "include"
      },
      "partner": {
        "matches": [],
        "type": "include"
      },
      "platform": {
        "matches": [],
        "type": "include"
      },
      "region": {
        "matches": [],
        "type": "include"
      },
      "revenue_source": {
        "matches": [],
        "type": "include"
      },
      "uid": {
        "matches": [],
        "type": "include"
      },
      "unit": {
        "matches": [],
        "type": "include"
      }
    },
    "order": null,
    "limit": null,
    "created_on": "2025-11-24 11:16:16",
    "table_state": null,
    "temporary": true
  },
  "success": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
integer
required

Unique report ID

Body

application/json
​
date_range
enum<string>
required

Pick a dynamic or fixed date range. If custom then custom_date is also required.

Available options:
custom,
yesterday,
seven_days,
thirty_days,
three_months,
six_months,
last_week,
last_month,
last_quarter,
last_year,
week_to_date,
month_to_date,
quarter_to_date,
year_to_date,
all_time
​
fields
enum<string>[]
required

Pick two or more fields to build the report, note that some fields are incompatible with others.

Available options:
account_name,
account_owner,
ad_impressions,
ad_requests,
ad_responses,
ad_unit_loads,
campaign_advertiser,
campaign,
channel,
clicks,
config_id,
config_name,
cost,
creative_size,
ctr,
date,
device,
ecpm,
environment,
fill,
geo,
gross_revenue,
imp_fill,
line_item,
month,
net_revenue,
organisation,
partner,
platform,
publisher,
q1_impressions,
q1_percent,
q2_impressions,
q2_percent,
q3_impressions,
q3_percent,
q4_impressions,
q4_percent,
region,
revenue_source,
rpm,
uid,
unit_fill,
unit,
viewability,
viewable_impressions
​
temporary
boolean
required

If true, report wont show up in the list of reports in platform, if false, title is required

​
filters
object

Filter data on various fields

​
title
string

Required if temporary=false

​
custom_date
object

Used when date_range is set to custom to provide the start and end date

Response

200 - application/json
​
results
object
​
success
boolean