Schemas

Reports Schema

Property	Type	Description / Example	Required
report_type	string	Example: PERFORMANCE, CONVERSION, ROAS, UNIVERSAL_PIXEL	✅
output_format	string	Example: CSV, JSON, XML
destination	string	Example: S3
time_zone	string	Example: America/Los Angeles, GMT, EST, UTC
filter	array	Items: [Filter]
fields	array	Items: [Fields]
metrics	array	Items: [Metrics]

Filter Schema

Criteria to specify your data set. Must be applied to all report types. 'from_date' and 'to_date' required.

Property	Type	Format	Example	Required
from_date	string	date-time		✅
to_date	string	date-time		✅
agency_ids	array		string[]
advertiser_ids	array		integer[]
campaign_ids	array		string[]
order_ids	array		string[]
line_ids	array		string[]

Fields

The categories of your custom report. Some fields vary per report type. A minimum of 1 field is required to create a new report. Expand each report type below to see a list of its supported fields.

Fields – Performance Report

Property	Type	Format	Example
account_id	number
account_name	string
advertiser_currency_code	string
advertiser_id	number
advertiser_name	string
external_advertiser_id	string
agency_id	number
agency_name	string
external_agency_id	string
agegroup_name	string		18-24, 25-34, 35-44
campaign_daily_budget	number
campaign_days_remaining	number
campaign_days_since_start	number
campaign_end_date	string	date-time
campaign_id	number
campaign_identifier	string		Device
campaign_lifetime_budget	number
campaign_name	string
campaign_start_date	string	date-time
campaign_total_days	number
objective	string
conversion_pixel_id	number
conversion_pixel_name	string
conversion_pixel_type	string
creative_external_id	string
creative_id	number
creative_name	string
creative_size	string		300x250
creative_type	string		image
currency_code	string		USD, GBP, EUR, CAD, AUD
currency_id	number
currency_name	string		US Dollar
date	string	date-time
day_of_week	string
device_brand	string		Apple, Google, Samsung
device_browser	string
device_lang	string
device_model	string		iPhone, iPad, Chrome, Safari - OS X
device_os	string		iPhone OS, Windows, Chrome OS, OS X, Android
device_os_version	string
device_type	string		smart phone, personal computer, tablet
hour	string		00:00
io_number	string
external_campaign_id	string
inventory_channel_id	number
inventory_channel_name	string		Mobile, Desktop
inventory_exchange_id	number
inventory_exchange_name	string
inventory_norm_site_name	string
inventory_site_id	number
inventory_site_name	string
inventory_site_type	string		web, app
line_id	number
line_name	string
external_line_id	string
location_city	string		Los Angeles, Minneapolis, Portland
location_country_code	string		US, CA
location_country_name	string		United States, Canada
location_dma_name	string		Austin TX, Las Vegas NV, New York NY
location_postal_code	string		60107, 75206
location_region_code	string		CA, PA, NE, MA, FL
location_region_name	string		California, Arizona, Virginia
month	string		September
order_base_cpm_bid	number
order_daily_budget	number
order_end_date	string	date-time
order_hourly_pacing	string
order_id	number
external_order_id	string
order_lifetime_budget	number
order_name	string
order_optimization_goal	string
order_start_date	string	date-time
pmp_client_deal_id	string
pmp_deal_group_name	string
pmp_deal_id	string
pmp_deal_name	string
quarter	string		Q3
tz	string
user_gender_code	string		f, m, o
user_hhi_name	string		$0-$29, $80, $125
week	number		37
year	number		2022

Fields – Conversion Report

Field	Type	Format
`account_id`	`number`
`account_name`	`string`
`advertiser_currency_code`	`string`
`advertiser_id`	`number`
`advertiser_name`	`string`
`external_advertiser_id`	`string`
`agency_id`	`number`
`agency_name`	`string`
`external_agency_id`	`string`
`campaign_days_remaining`	`number`
`campaign_days_since_start`	`number`
`campaign_end_date`	`string`	`date-time`
`campaign_id`	`number`
`campaign_identifier`	`string`
`campaign_lifetime_budget`	`number`
`campaign_name`	`string`
`campaign_start_date`	`string`	`date-time`
`campaign_total_days`	`number`
`objective`	`string`
`creative_id`	`number`
`creative_name`	`string`
`creative_size`	`string`
`creative_type`	`string`
`date`	`string`	`date-time`
`io_number`	`string`
`external_campaign_id`	`string`
`line_id`	`number`
`line_name`	`string`
`external_line_id`	`string`
`order_base_cpm_bid`	`number`
`order_daily_budget`	`number`
`order_end_date`	`string`	`date-time`
`order_hourly_pacing`	`string`
`order_id`	`number`
`external_order_id`	`string`
`order_lifetime_budget`	`number`
`order_name`	`string`
`order_optimization_goal`	`string`
`order_start_date`	`string`	`date-time`
`pixel_id`	`string`
`pixel_name`	`string`
`pixel_type`	`string`

Fields – ROAS Report

Field	Type	Format
`account_id`	`number`
`account_name`	`string`
`advertiser_currency`	`string`
`advertiser_id`	`number`
`advertiser_name`	`string`
`external_advertiser_id`	`string`
`agency_id`	`number`
`agency_name`	`string`
`external_agency_id`	`string`
`campaign_daily_budget`	`number`
`campaign_days_remaining`	`number`
`campaign_days_since_start`	`number`
`campaign_end_date`	`string`	`date-time`
`campaign_id`	`number`
`campaign_identifier`	`string`
`campaign_lifetime_budget`	`number`
`external_campaign_id`	`string`
`line_id`	`number`
`line_name`	`string`
`external_line_id`	`string`
`order_base_cpm_bid`	`number`
`order_daily_budget`	`number`
`order_end_date`	`string`	`date-time`
`order_hourly_pacing`	`string`
`order_id`	`number`
`external_order_id`	`string`
`order_lifetime_budget`	`number`
`order_max_bid`	`number`
`order_name`	`string`
`order_optimization_goal`	`string`
`order_start_date`	`string`	`date-time`

Fields – Universal Pixel Report

Field	Type	Format
`advertiser_id`	`number`
`advertiser_name`	`string`
`external_advertiser_id`	`string`
`agency_id`	`number`
`agency_name`	`string`
`external_agency_id`	`string`
`currency`	`string`
`customer_type`	`string`
`page_url`	`string`
`parameter1`	`string`
`parameter2`	`string`
`parameter3`	`string`
`parameter4`	`string`
`parameter5`	`string`
`parameter6`	`string`
`parameter7`	`string`
`parameter8`	`string`
`parameter9`	`string`
`parameter10`	`string`
`pixel_event_timestamp`	`string`
`pixel_id`	`number`
`pixel_name`	`string`
`pixel_type`	`string`
`product_category`	`string`
`referrer_url`	`string`
`revenue`	`string`
`transaction_id`	`string`
`url`	`string`
`user_id`	`string`

Metrics

The summary data to be returned. Applicable to MOST report types. A minimum of 1 metric is required to create a new report. Expand each report type below to see a list of its supported metrics.

Metrics – Performance Report

Metric	Type
`viant_tech_fee`	`number`
`auction_win_rate`	`number`
`auction_won`	`number`
`avg_media_clearing_price`	`number`
`avg_media_spend`	`number`
`bids`	`number`
`bill_additional_fees`	`number`
`click_conversions`	`string`
`click_conversions_up`	`string`
`clicks`	`number`
`conversion_rate`	`number`
`conversion_up`	`number`
`conversions`	`number`
`cost_per_completed_view`	`number`
`cost_per_view`	`number`
`ctr`	`string`
`data_spend`	`number`
`ecpa`	`string`
`ecpc`	`string`
`ecpm`	`string`
`ias_high_risk`	`string`
`ias_low_risk`	`string`
`ias_measured_ads`	`string`
`ias_measured_rate`	`string`
`ias_moderate_risk`	`string`
`ias_not_viewable_ads`	`string`
`ias_perc_in_view`	`string`
`ias_perc_in_view_15s`	`string`
`ias_perc_in_view_5s`	`string`
`ias_perc_out_view`	`string`
`ias_perc_suspicious_imps`	`string`
`ias_perc_video_4q_in_view`	`string`
`ias_perc_video_never_started`	`string`
`ias_very_high_risk`	`string`
`ias_viewable_imps`	`string`
`ias_viewable_rate`	`string`
`impressions`	`number`
`managed_service_fee`	`string`
`media_clearing_price`	`number`
`media_spend`	`number`
`non_bill_additional_fees`	`number`
`offline_purchases`	`string`
`offline_sales`	`string`
`render_rate`	`number`
`spend`	`number`
`v_100`	`number`
`v_100_rate`	`number`
`v_25`	`number`
`v_50`	`number`
`v_75`	`number`
`vast_impressions`	`number`
`vcpm`	`number`
`view_conversions`	`string`
`view_conversions_up`	`string`
`visits`	`number`
`win_rate`	`number`

Metrics – Conversion Report

Metric	Type
`add_payment_info`	`string`
`add_to_cart`	`string`
`conversions`	`string`
`conversion_up`	`string`
`initiate_checkout`	`string`
`item_view`	`string`
`landing_page`	`string`
`lead`	`string`
`other`	`string`
`page_view`	`string`
`post_click_conversions`	`string`
`post_click_conversion_up`	`string`
`post_click_revenue`	`string`
`post_view_conversions`	`string`
`post_view_conversion_up`	`string`
`post_view_revenue`	`string`
`purchase`	`string`
`revenue`	`string`

Metrics – ROAS Report

Metric	Type
`add_payment_info`	`string`
`add_to_cart`	`string`
`conversion_up`	`string`
`conversions`	`string`
`initiate_checkout`	`string`
`item_view`	`string`
`landing_page`	`string`
`lead`	`string`
`other`	`string`
`page_view`	`string`
`post_click_conversion_up`	`string`
`post_click_conversions`	`string`
`post_click_revenue`	`string`
`post_view_conversion_up`	`string`
`post_view_conversions`	`string`
`post_view_revenue`	`string`
`purchase`	`string`
`revenue`	`string`

Metrics – Universal Pixel Report

Metric	Type
`advertiser_id`	`number`
`advertiser_name`	`string`
`external_advertiser_id`	`string`
`agency_id`	`number`
`agency_name`	`string`
`external_agency_id`	`string`
`campaign_id`	`number`
`campaign_name`	`string`
`external_campaign_id`	`string`
`order_id`	`number`
`order_name`	`string`
`external_order_id`	`string`
`line_id`	`number`
`line_name`	`string`
`external_line_id`	`string`
`creative_id`	`number`
`creative_name`	`string`
`creative_size`	`string`
`creative_type`	`string`
`conversion_pixel_id`	`number`
`conversion_pixel_name`	`string`
`conversion_pixel_type`	`string`
`device_os`	`string`
`device_type`	`string`
`event_date`	`string`
`event_name`	`string`
`event_value`	`string`
`customer_type`	`string`
`page_url`	`string`
`parameter1`	`string`

Response Schema

Structure of a successful response, provided for reference.

Property	Type	Format	Example
token	string		hlKi6zr4y1ws1y3nYTLkdK4EDOFeqAK6
status	string		In Progress
download_url	string
updated_at	string	date-time