Reporting API V2 (1.0.0)
https://api.mediamath.com/reporting/v2/
Request
Standard performance metrics in campaign currency and broken out by our widest array of dimensions. Available in custom date ranges or intervals with the option to aggregate by day, week, or month.
Fields
Field | Time Windows | Rollups |
---|---|---|
Dimensions | ||
agg_timestamp | current_day , last_X_days , month_to_date , yesterday | by_day , by_month , by_week |
ads_txt_type Ads.txt Type | Any | Any |
ads_txt_verified Ads.txt Verified | Any | Any |
advertiser_id | Any | Any |
advertiser_name | Any | Any |
agency_id | Any | Any |
agency_name | Any | Any |
app_id | Any | Any |
app_name | Any | Any |
app_store | Any | Any |
attribution_group | Any | Any |
auction_type | Any | Any |
bid_price_impact | Any | Any |
browser | Any | Any |
browser_version | Any | Any |
campaign_ads_txt_verified | Any | Any |
campaign_agency_fee_pct | Any | Any |
campaign_archived | Any | Any |
campaign_bid_min_devices | Any | Any |
campaign_brain_intraday_pacing | Any | Any |
campaign_connected_id_type | Any | Any |
campaign_conversion_type | Any | Any |
campaign_conversion_variable_minutes | Any | Any |
campaign_cost_passthrough_cpm_enabled | Any | Any |
campaign_cost_passthrough_cpm_value | Any | Any |
campaign_cost_passthrough_percent_enabled | Any | Any |
campaign_cost_passthrough_percent_value | Any | Any |
campaign_created_on Campaign Creation Time | Any | Any |
campaign_currency_code Campaign Currency Code | Any | Any |
campaign_custom_attribution_source | Any | Any |
campaign_dcs_data_is_campaign_level | Any | Any |
campaign_device_graph_only | Any | Any |
campaign_dynamic_budget_allocation_applied | Any | Any |
campaign_dynamic_budget_allocation_available | Any | Any |
campaign_dynamic_budget_allocation_type | Any | Any |
campaign_end_date (GMT) Campaign End Date | Any | Any |
campaign_end_date_tz (CTZ) Campaign End Date | Any | Any |
campaign_frequency_amount Campaign Frequency Amount | Any | Any |
campaign_frequency_interval Campaign Frequency Interval | Any | Any |
campaign_frequency_optimization Campaign Frequency Optimization | Any | Any |
campaign_frequency_type Campaign Frequency Type | Any | Any |
campaign_goal_alert | Any | Any |
campaign_goal_category | Any | Any |
campaign_goal_type | Any | Any |
campaign_goal_value | Any | Any |
campaign_has_custom_attribution | Any | Any |
campaign_id | Any | Any |
campaign_impression_cap_amount | Any | Any |
campaign_impression_cap_automatic | Any | Any |
campaign_impression_cap_type | Any | Any |
campaign_in_flight In Flight | Any | Any |
campaign_initial_start_date (GMT) Campaign Initial Start Date | Any | Any |
campaign_initial_start_date_tz (CTZ) Campaign Initial Start Date | Any | Any |
campaign_io_name | Any | Any |
campaign_io_reference_num | Any | Any |
campaign_is_programmatic_guaranteed Campaign Is Programmatic Guaranteed | Any | Any |
campaign_merit_pixel_id | Any | Any |
campaign_minimize_multi_ads Minimize Multi Ads | Any | Any |
campaign_name | Any | Any |
campaign_override_suspicious_traffic_filter | Any | Any |
campaign_pacing_alert | Any | Any |
campaign_pc_window_minutes | Any | Any |
campaign_political | Any | Any |
campaign_pv_pct | Any | Any |
campaign_pv_window_minutes | Any | Any |
campaign_restrict_targeting_to_deterministic_id | Any | Any |
campaign_restrict_targeting_to_same_device_id | Any | Any |
campaign_service_type Campaign Service Type, a.k.a. Managed Service Flag / managed_service_flag | Any | Any |
campaign_source_campaign_id | Any | Any |
campaign_spend_cap_amount | Any | Any |
campaign_spend_cap_automatic | Any | Any |
campaign_spend_cap_daily_cap | Any | Any |
campaign_spend_cap_type | Any | Any |
campaign_start_date (GMT) Campaign Start Date | Any | Any |
campaign_start_date_tz (CTZ) Campaign Start Date | Any | Any |
campaign_status Active Status | Any | Any |
campaign_suspicious_traffic_filter_level | Any | Any |
campaign_total_budget | Any | Any |
campaign_total_impression_budget Campaign Impressions Budget | Any | Any |
campaign_updated_on Campaign Update Time | Any | Any |
campaign_version | Any | Any |
campaign_zone_name Campaign Time Zone, a.k.a time_zone | Any | Any |
channel_type | Any | Any |
city_code | Any | Any |
city_name | Any | Any |
concept_id | Any | Any |
concept_name | Any | Any |
conn_speed Connection Speed | Any | Any |
conn_speed_name | Any | Any |
content_title | Any | Any |
country | Any | Any |
country_name | Any | Any |
creative_file_type | Any | Any |
creative_has_sound | Any | Any |
creative_id | Any | Any |
creative_is_native | Any | Any |
creative_name | Any | Any |
creative_rich_media | Any | Any |
creative_size | Any | Any |
creative_tpas_placement_id | Any | Any |
creative_tpas_placement_name | Any | Any |
currency_rate_date | Any | Any |
currency_rate_rate | Any | Any |
deal_exchange_id | Any | Any |
deal_external_id | Any | Any |
deal_group_id | Any | Any |
deal_group_name | Any | Any |
deal_id | Any | Any |
deal_name | Any | Any |
deal_organization_id | Any | Any |
deal_price_type | Any | Any |
deal_publisher_id Deal Publisher ID | Any | Any |
device_make | Any | Any |
device_model | Any | Any |
exchange_id | Any | Any |
exchange_name | Any | Any |
flight_id | Any | Any |
form_factor Device Type | Any | Any |
inventory_browser_type | Any | Any |
inventory_market_type | Any | Any |
isp | Any | Any |
isp_name | Any | Any |
media_name | Any | Any |
metro_code | Any | Any |
metro_name | Any | Any |
mm_buying_modality Buying Modality | Any | Any |
openrtb_device_type OpenRTB Device Type | Any | Any |
organization_id | Any | Any |
organization_name | Any | Any |
os_type OS Type | Any | Any |
os_version OS Version | Any | Any |
postal_code_name | Any | Any |
primary_seller_id | Any | Any |
primary_seller_name | Any | Any |
prisma_campaign_id | Any | Any |
prisma_client_product_estimate | Any | Any |
prisma_io_number | Any | Any |
publisher_id | Any | Any |
publisher_name | Any | Any |
region | Any | Any |
region_name | Any | Any |
site_domain | Any | Any |
strategy_ads_txt_verified | Any | Any |
strategy_archived | Any | Any |
strategy_audience_segment_exclude_op | Any | Any |
strategy_audience_segment_include_op | Any | Any |
strategy_bid_aggressiveness | Any | Any |
strategy_bid_min_devices | Any | Any |
strategy_bid_price_is_media_only | Any | Any |
strategy_budget | Any | Any |
strategy_cost_passthrough_cpm_enabled | Any | Any |
strategy_cost_passthrough_cpm_value | Any | Any |
strategy_cost_passthrough_percent_enabled | Any | Any |
strategy_cost_passthrough_percent_value | Any | Any |
strategy_created_on | Any | Any |
strategy_currency_code | Any | Any |
strategy_description | Any | Any |
strategy_device_graph_only | Any | Any |
strategy_end_date_raw | Any | Any |
strategy_exchange_type_for_run_on_all | Any | Any |
strategy_feature_compatibility | Any | Any |
strategy_frequency_amount | Any | Any |
strategy_frequency_interval Campaign Frequency Interval | Any | Any |
strategy_frequency_optimization | Any | Any |
strategy_frequency_type Campaign Frequency Type | Any | Any |
strategy_goal_type | Any | Any |
strategy_goal_value | Any | Any |
strategy_groups | Any | Any |
strategy_id | Any | Any |
strategy_impression_pacing_amount | Any | Any |
strategy_impression_pacing_interval | Any | Any |
strategy_impression_pacing_type | Any | Any |
strategy_max_bid | Any | Any |
strategy_max_bid_wm | Any | Any |
strategy_media_type | Any | Any |
strategy_min_bid | Any | Any |
strategy_name | Any | Any |
strategy_pacing_amount | Any | Any |
strategy_pacing_interval | Any | Any |
strategy_pacing_optimization_amount | Any | Any |
strategy_pacing_optimization_type | Any | Any |
strategy_pacing_type | Any | Any |
strategy_roi_target | Any | Any |
strategy_run_on_all_exchanges | Any | Any |
strategy_run_on_all_pmp | Any | Any |
strategy_run_on_display | Any | Any |
strategy_run_on_mobile | Any | Any |
strategy_run_on_only_fraud_filtered_exchanges | Any | Any |
strategy_run_on_streaming | Any | Any |
strategy_site_restriction_transparent_urls | Any | Any |
strategy_site_selectiveness | Any | Any |
strategy_source_only | Any | Any |
strategy_start_date_raw | Any | Any |
strategy_status Active Status | Any | Any |
strategy_supply_type | Any | Any |
strategy_targeting_segment_exclude_op | Any | Any |
strategy_targeting_segment_include_op | Any | Any |
strategy_type | Any | Any |
strategy_updated_on | Any | Any |
strategy_use_bid_shading | Any | Any |
strategy_use_campaign_end | Any | Any |
strategy_use_campaign_start | Any | Any |
strategy_use_dba_strategy_pacing | Any | Any |
strategy_use_dba_strategy_pacing_after_date | Any | Any |
strategy_use_mm_freq | Any | Any |
strategy_use_optimization | Any | Any |
strategy_version | Any | Any |
strategy_zone_name | Any | Any |
video_placement | Any | Any |
video_skippability | Any | Any |
zip | Any | Any |
Metrics | ||
accept_invitation_count | Any | Any |
calculated_impressions | Any | Any |
clicks | Any | Any |
ctc CTC | Any | Any |
ctr CTR | Any | Any |
general_invalid_clicks | Any | Any |
impressions | Any | Any |
in_view In View Impressions | Any | Any |
in_view_100_percent 100% In View Impressions | Any | Any |
in_view_15_seconds In View - 15 Seconds | Any | Any |
in_view_15_seconds_rate In View 15 Seconds Rate | Any | Any |
in_view_5_seconds In View - 5 Seconds | Any | Any |
in_view_5_seconds_rate In View 5 Seconds Rate | Any | Any |
in_view_q1 | Any | Any |
in_view_q2 | Any | Any |
in_view_q3 | Any | Any |
in_view_q4 | Any | Any |
measurability_rate Measurability Rate | Any | Any |
measurable Measurable Impressions | Any | Any |
media_cost | Any | Any |
media_cost_usd (USD) Media Cost | Any | Any |
non_watermark_impressions Non-Watermark Impressions | Any | Any |
non_watermark_spend_usd Non-Watermark Spend (USD) | Any | Any |
post_click_aov Post-Click AOV | Any | Any |
post_click_aov_usd (USD) Post-Click AOV | Any | Any |
post_click_conversions Post-Click Conversions | Any | Any |
post_click_revenue Post-Click Revenue | Any | Any |
post_click_revenue_usd (USD) Post-Click Revenue | Any | Any |
post_click_total_spend_roi Post-Click Total Spend ROI | Any | Any |
post_view_aov Post-View AOV | Any | Any |
post_view_aov_usd (USD) Post-View AOV | Any | Any |
post_view_conversions Post-View Conversions | Any | Any |
post_view_revenue Post-View Revenue | Any | Any |
post_view_revenue_usd (USD) Post-View Revenue | Any | Any |
post_view_total_spend_roi Post-View Total Spend ROI | Any | Any |
rr_per_1k_imps Response Rate/1K Imps | Any | Any |
third_party_events 3PA Events | Any | Any |
third_party_revenue 3PA Total Revenue | Any | Any |
third_party_revenue_usd (USD) 3PA Total Revenue | Any | Any |
total_aov Total AOV | Any | Any |
total_aov_usd (USD) Total AOV | Any | Any |
total_clicks | Any | Any |
total_conversions | Any | Any |
total_revenue | Any | Any |
total_revenue_usd (USD) Total Revenue | Any | Any |
total_spend | Any | Any |
total_spend_cpa Total Spend eCPA | Any | Any |
total_spend_cpa_usd (USD) Total Spend eCPA | Any | Any |
total_spend_cpc Total Spend eCPC | Any | Any |
total_spend_cpc_usd (USD) Total Spend eCPC | Any | Any |
total_spend_cpcv Total Spend eCPCV | Any | Any |
total_spend_cpcv_usd (USD) Total Spend eCPCV | Any | Any |
total_spend_cpm Total Spend eCPM | Any | Any |
total_spend_cpm_usd (USD) Total Spend eCPM | Any | Any |
total_spend_pc_cpa Total Spend PC CPA | Any | Any |
total_spend_pc_cpa_usd (USD) Total Spend PC CPA | Any | Any |
total_spend_pv_cpa Total Spend PV CPA | Any | Any |
total_spend_pv_cpa_usd (USD) Total Spend PV CPA | Any | Any |
total_spend_roi Total Spend ROI | Any | Any |
total_spend_usd (USD) Total Spend | Any | Any |
total_spend_vcpm Total Spend vCPM | Any | Any |
total_spend_vcpm_usd (USD) Total Spend vCPM | Any | Any |
video_close Close | Any | Any |
video_collapse Collapse | Any | Any |
video_companion_clicks Companion Clicks | Any | Any |
video_companion_ctr Companion CTR | Any | Any |
video_companion_impressions Companion Impressions | Any | Any |
video_complete 100% Completed Views | Any | Any |
video_complete_rate 100% Completed Rate | Any | Any |
video_complete_rate_impression_based 100% Completed Rate - Impressions Based | Any | Any |
video_engaged_impressions Engaged Impressions | Any | Any |
video_engaged_rate Engaged Rate | Any | Any |
video_expand Expand | Any | Any |
video_first_quartile 25% Completed Views | Any | Any |
video_first_quartile_rate 25% Completed Rate | Any | Any |
video_first_quartile_rate_impression_based 25% Completed Rate - Impressions Based | Any | Any |
video_fullscreen Fullscreen | Any | Any |
video_midpoint 50% Completed Views | Any | Any |
video_midpoint_rate 50% Completed Rate | Any | Any |
video_midpoint_rate_impression_based 50% Completed Rate - Impressions Based | Any | Any |
video_mute Mute | Any | Any |
video_pause Pause | Any | Any |
video_play_rate Play Rate | Any | Any |
video_resume Resume | Any | Any |
video_rewind Rewind | Any | Any |
video_skip Skip | Any | Any |
video_skippable_impressions Skippable Impressions | Any | Any |
video_skipped_impressions Skipped Impressions | Any | Any |
video_skipped_rate Skipped Rate | Any | Any |
video_start Start | Any | Any |
video_third_quartile 75% Completed Views | Any | Any |
video_third_quartile_rate 75% Completed Rate | Any | Any |
video_third_quartile_rate_impression_based 75% Completed Rate - Impressions Based | Any | Any |
video_unmute Unmute | Any | Any |
viewability_rate Viewability Rate | Any | Any |
viewability_rate_100_percent 100% In View Rate | Any | Any |
watermark_impressions | Any | Any |
watermark_spend_pct Watermark Spend Percent | Any | Any |
watermark_spend_usd Watermark Spend (USD) | Any | Any |
Pageable
No
Time Windows
current_day
, last_X_days
, month_to_date
, yesterday
Rollups
all
, by_day
, by_month
, by_week
Data Retention / Lookback Window
1 year
=
: Equals or contains ifvalue
is an array!=
: Not equals>
: Greater than>=
: Greater than or equals<
: Less than<=
: Less than or equals=~
: Text contains (case-insensitive)and
: All filters must matchor
: At least one filter must match
- Live Server
https://api.mediamath.com/reporting/v2/all-dimensions-and-metrics
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.mediamath.com/reporting/v2/all-dimensions-and-metrics \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"end_time": "2019-08-24T14:15:22Z",
"fields": [
"string"
],
"filters": [
{
"field": "string",
"filters": [
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
},
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
}
],
"op": "=",
"value": 0
}
],
"full_entities": [
"string"
],
"order": [
{
"desc": false,
"field": "string",
"nulls_last": false
}
],
"rollup": "string",
"start_time": "2019-08-24T14:15:22Z",
"time_window": "string",
"time_zone": "string"
}'
"{\"fields\":[{\"name\":\"agg_timestamp\"},{\"name\":\"campaign_id\"},{\"name\":\"impressions\"}],\"total_items_count\":14}\n{\"campaign_id\":102461,\"impressions\":93283,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}\n{\"campaign_id\":1228153,\"impressions\":484,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}\n{\"campaign_id\":1245119,\"impressions\":0,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}"
Request
Special index metrics for comparing your site visitors to 3rd party segments. Broken out by audience name and pixel.
Fields
Field | Time Windows | Rollups |
---|---|---|
Dimensions | ||
advertiser_id | Any | Any |
advertiser_name | Any | Any |
agency_id | Any | Any |
agency_name | Any | Any |
audience_id | Any | Any |
audience_name | Any | Any |
audience_path | Any | Any |
campaign_ads_txt_verified | Any | Any |
campaign_agency_fee_pct | Any | Any |
campaign_archived | Any | Any |
campaign_bid_min_devices | Any | Any |
campaign_brain_intraday_pacing | Any | Any |
campaign_connected_id_type | Any | Any |
campaign_conversion_type | Any | Any |
campaign_conversion_variable_minutes | Any | Any |
campaign_cost_passthrough_cpm_enabled | Any | Any |
campaign_cost_passthrough_cpm_value | Any | Any |
campaign_cost_passthrough_percent_enabled | Any | Any |
campaign_cost_passthrough_percent_value | Any | Any |
campaign_created_on Campaign Creation Time | Any | Any |
campaign_currency_code Campaign Currency Code | Any | Any |
campaign_custom_attribution_source | Any | Any |
campaign_dcs_data_is_campaign_level | Any | Any |
campaign_device_graph_only | Any | Any |
campaign_dynamic_budget_allocation_applied | Any | Any |
campaign_dynamic_budget_allocation_available | Any | Any |
campaign_dynamic_budget_allocation_type | Any | Any |
campaign_end_date (GMT) Campaign End Date | Any | Any |
campaign_end_date_tz (CTZ) Campaign End Date | Any | Any |
campaign_frequency_amount Campaign Frequency Amount | Any | Any |
campaign_frequency_interval Campaign Frequency Interval | Any | Any |
campaign_frequency_optimization Campaign Frequency Optimization | Any | Any |
campaign_frequency_type Campaign Frequency Type | Any | Any |
campaign_goal_alert | Any | Any |
campaign_goal_category | Any | Any |
campaign_goal_type | Any | Any |
campaign_goal_value | Any | Any |
campaign_has_custom_attribution | Any | Any |
campaign_id | Any | Any |
campaign_impression_cap_amount | Any | Any |
campaign_impression_cap_automatic | Any | Any |
campaign_impression_cap_type | Any | Any |
campaign_in_flight In Flight | Any | Any |
campaign_initial_start_date (GMT) Campaign Initial Start Date | Any | Any |
campaign_initial_start_date_tz (CTZ) Campaign Initial Start Date | Any | Any |
campaign_io_name | Any | Any |
campaign_io_reference_num | Any | Any |
campaign_is_programmatic_guaranteed Campaign Is Programmatic Guaranteed | Any | Any |
campaign_merit_pixel_id | Any | Any |
campaign_minimize_multi_ads Minimize Multi Ads | Any | Any |
campaign_name | Any | Any |
campaign_override_suspicious_traffic_filter | Any | Any |
campaign_pacing_alert | Any | Any |
campaign_pc_window_minutes | Any | Any |
campaign_political | Any | Any |
campaign_pv_pct | Any | Any |
campaign_pv_window_minutes | Any | Any |
campaign_restrict_targeting_to_deterministic_id | Any | Any |
campaign_restrict_targeting_to_same_device_id | Any | Any |
campaign_service_type Campaign Service Type, a.k.a. Managed Service Flag / managed_service_flag | Any | Any |
campaign_source_campaign_id | Any | Any |
campaign_spend_cap_amount | Any | Any |
campaign_spend_cap_automatic | Any | Any |
campaign_spend_cap_daily_cap | Any | Any |
campaign_spend_cap_type | Any | Any |
campaign_start_date (GMT) Campaign Start Date | Any | Any |
campaign_start_date_tz (CTZ) Campaign Start Date | Any | Any |
campaign_status Active Status | Any | Any |
campaign_suspicious_traffic_filter_level | Any | Any |
campaign_total_budget | Any | Any |
campaign_total_impression_budget Campaign Impressions Budget | Any | Any |
campaign_updated_on Campaign Update Time | Any | Any |
campaign_version | Any | Any |
campaign_zone_name Campaign Time Zone, a.k.a time_zone | Any | Any |
organization_id | Any | Any |
organization_name | Any | Any |
Metrics | ||
audience_index Measure of users exposed to your site/media against general internet population | Any | Any |
matched_impressions | Any | Any |
Pageable
Yes
Time Windows
last_14_days
Rollups
all
=
: Equals or contains ifvalue
is an array!=
: Not equals>
: Greater than>=
: Greater than or equals<
: Less than<=
: Less than or equals=~
: Text contains (case-insensitive)and
: All filters must matchor
: At least one filter must match
- Live Server
https://api.mediamath.com/reporting/v2/audience-index
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.mediamath.com/reporting/v2/audience-index \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"fields": [
"string"
],
"filters": [
{
"field": "string",
"filters": [
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
},
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
}
],
"op": "=",
"value": 0
}
],
"full_entities": [
"string"
],
"order": [
{
"desc": false,
"field": "string",
"nulls_last": false
}
],
"pagination": {
"page_index": 0,
"page_size": 1
},
"rollup": "string",
"time_window": "string",
"time_zone": "string"
}'
{ "meta": { "items_count": 0, "page_index": 0, "status": "ok", "total_items_count": 0, "total_pages": 0 }, "results": [ {} ] }
Request
Special index metrics for comparing your site visitors to 3rd party segments. Broken out by audience name and pixel. Currently available in one interval: last 14 days.
Fields
Field | Time Windows | Rollups |
---|---|---|
Dimensions | ||
advertiser_id | Any | Any |
advertiser_name | Any | Any |
agency_id | Any | Any |
agency_name | Any | Any |
audience_id | Any | Any |
audience_name | Any | Any |
audience_path | Any | Any |
organization_id | Any | Any |
organization_name | Any | Any |
pixel_created_on Pixel Creation Time | Any | Any |
pixel_eligible | Any | Any |
pixel_external_identifier | Any | Any |
pixel_id | Any | Any |
pixel_name | Any | Any |
pixel_provider_created_on | Any | Any |
pixel_provider_id | Any | Any |
pixel_provider_name | Any | Any |
pixel_provider_updated_on | Any | Any |
pixel_status | Any | Any |
pixel_tag_type | Any | Any |
pixel_type | Any | Any |
pixel_updated_on Pixel Update Time | Any | Any |
Metrics | ||
audience_index Measure of users exposed to your site/media against general internet population | Any | Any |
matched_users | Any | Any |
Pageable
Yes
Time Windows
last_14_days
Rollups
all
=
: Equals or contains ifvalue
is an array!=
: Not equals>
: Greater than>=
: Greater than or equals<
: Less than<=
: Less than or equals=~
: Text contains (case-insensitive)and
: All filters must matchor
: At least one filter must match
- Live Server
https://api.mediamath.com/reporting/v2/audience-index-pixel
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.mediamath.com/reporting/v2/audience-index-pixel \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"fields": [
"string"
],
"filters": [
{
"field": "string",
"filters": [
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
},
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
}
],
"op": "=",
"value": 0
}
],
"full_entities": [
"string"
],
"order": [
{
"desc": false,
"field": "string",
"nulls_last": false
}
],
"pagination": {
"page_index": 0,
"page_size": 1
},
"rollup": "string",
"time_window": "string",
"time_zone": "string"
}'
{ "meta": { "items_count": 0, "page_index": 0, "status": "ok", "total_items_count": 0, "total_pages": 0 }, "results": [ {} ] }
Request
Brain Feature Summary Report
Fields
Field | Time Windows | Rollups |
---|---|---|
Dimensions | ||
advertiser_id | Any | Any |
advertiser_name | Any | Any |
agency_id | Any | Any |
agency_name | Any | Any |
campaign_id | Any | Any |
campaign_name | Any | Any |
feature | Any | Any |
index | Any | Any |
model_goal | Any | Any |
organization_id | Any | Any |
organization_name | Any | Any |
position | Any | Any |
Metrics |
Pageable
Yes
Time Windows
last_X_days
, month_to_date
, yesterday
Rollups
by_day
=
: Equals or contains ifvalue
is an array!=
: Not equals>
: Greater than>=
: Greater than or equals<
: Less than<=
: Less than or equals=~
: Text contains (case-insensitive)and
: All filters must matchor
: At least one filter must match
- Live Server
https://api.mediamath.com/reporting/v2/brain-feature-summary
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.mediamath.com/reporting/v2/brain-feature-summary \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"end_time": "2019-08-24T14:15:22Z",
"fields": [
"string"
],
"filters": [
{
"field": "string",
"filters": [
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
},
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
}
],
"op": "=",
"value": 0
}
],
"full_entities": [
"string"
],
"order": [
{
"desc": false,
"field": "string",
"nulls_last": false
}
],
"pagination": {
"page_index": 0,
"page_size": 1
},
"rollup": "string",
"start_time": "2019-08-24T14:15:22Z",
"time_window": "string",
"time_zone": "string"
}'
{ "meta": { "items_count": 0, "page_index": 0, "status": "ok", "total_items_count": 0, "total_pages": 0 }, "results": [ {} ] }
Request
Brain Feature Value Report
Fields
Field | Time Windows | Rollups |
---|---|---|
Dimensions | ||
advertiser_id | Any | Any |
advertiser_name | Any | Any |
agency_id | Any | Any |
agency_name | Any | Any |
bid_impact | Any | Any |
campaign_id | Any | Any |
campaign_name | Any | Any |
feature | Any | Any |
feature_report_type | Any | Any |
feature_value | Any | Any |
index | Any | Any |
is_numeric | Any | Any |
mean | Any | Any |
model_goal | Any | Any |
organization_id | Any | Any |
organization_name | Any | Any |
position | Any | Any |
Metrics |
Pageable
Yes
Time Windows
last_X_days
, month_to_date
, yesterday
Rollups
by_day
=
: Equals or contains ifvalue
is an array!=
: Not equals>
: Greater than>=
: Greater than or equals<
: Less than<=
: Less than or equals=~
: Text contains (case-insensitive)and
: All filters must matchor
: At least one filter must match
- Live Server
https://api.mediamath.com/reporting/v2/brain-feature-value
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.mediamath.com/reporting/v2/brain-feature-value \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"end_time": "2019-08-24T14:15:22Z",
"fields": [
"string"
],
"filters": [
{
"field": "string",
"filters": [
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
},
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
}
],
"op": "=",
"value": 0
}
],
"full_entities": [
"string"
],
"order": [
{
"desc": false,
"field": "string",
"nulls_last": false
}
],
"pagination": {
"page_index": 0,
"page_size": 1
},
"rollup": "string",
"start_time": "2019-08-24T14:15:22Z",
"time_window": "string",
"time_zone": "string"
}'
{ "meta": { "items_count": 0, "page_index": 0, "status": "ok", "total_items_count": 0, "total_pages": 0 }, "results": [ {} ] }
Request
Standard performance metrics broken out by contextual categories that strategies are targeting
Fields
Field | Time Windows | Rollups |
---|---|---|
Dimensions | ||
agg_timestamp | current_day , last_X_days , month_to_date , yesterday | by_day , by_month , by_week |
advertiser_id | Any | Any |
advertiser_name | Any | Any |
agency_id | Any | Any |
agency_name | Any | Any |
attribution_group | Any | Any |
campaign_ads_txt_verified | Any | Any |
campaign_agency_fee_pct | Any | Any |
campaign_archived | Any | Any |
campaign_bid_min_devices | Any | Any |
campaign_brain_intraday_pacing | Any | Any |
campaign_connected_id_type | Any | Any |
campaign_conversion_type | Any | Any |
campaign_conversion_variable_minutes | Any | Any |
campaign_cost_passthrough_cpm_enabled | Any | Any |
campaign_cost_passthrough_cpm_value | Any | Any |
campaign_cost_passthrough_percent_enabled | Any | Any |
campaign_cost_passthrough_percent_value | Any | Any |
campaign_created_on Campaign Creation Time | Any | Any |
campaign_currency_code Campaign Currency Code | Any | Any |
campaign_custom_attribution_source | Any | Any |
campaign_dcs_data_is_campaign_level | Any | Any |
campaign_device_graph_only | Any | Any |
campaign_dynamic_budget_allocation_applied | Any | Any |
campaign_dynamic_budget_allocation_available | Any | Any |
campaign_dynamic_budget_allocation_type | Any | Any |
campaign_end_date (GMT) Campaign End Date | Any | Any |
campaign_end_date_tz (CTZ) Campaign End Date | Any | Any |
campaign_frequency_amount Campaign Frequency Amount | Any | Any |
campaign_frequency_interval Campaign Frequency Interval | Any | Any |
campaign_frequency_optimization Campaign Frequency Optimization | Any | Any |
campaign_frequency_type Campaign Frequency Type | Any | Any |
campaign_goal_alert | Any | Any |
campaign_goal_category | Any | Any |
campaign_goal_type | Any | Any |
campaign_goal_value | Any | Any |
campaign_has_custom_attribution | Any | Any |
campaign_id | Any | Any |
campaign_impression_cap_amount | Any | Any |
campaign_impression_cap_automatic | Any | Any |
campaign_impression_cap_type | Any | Any |
campaign_in_flight In Flight | Any | Any |
campaign_initial_start_date (GMT) Campaign Initial Start Date | Any | Any |
campaign_initial_start_date_tz (CTZ) Campaign Initial Start Date | Any | Any |
campaign_io_name | Any | Any |
campaign_io_reference_num | Any | Any |
campaign_is_programmatic_guaranteed Campaign Is Programmatic Guaranteed | Any | Any |
campaign_merit_pixel_id | Any | Any |
campaign_minimize_multi_ads Minimize Multi Ads | Any | Any |
campaign_name | Any | Any |
campaign_override_suspicious_traffic_filter | Any | Any |
campaign_pacing_alert | Any | Any |
campaign_pc_window_minutes | Any | Any |
campaign_political | Any | Any |
campaign_pv_pct | Any | Any |
campaign_pv_window_minutes | Any | Any |
campaign_restrict_targeting_to_deterministic_id | Any | Any |
campaign_restrict_targeting_to_same_device_id | Any | Any |
campaign_service_type Campaign Service Type, a.k.a. Managed Service Flag / managed_service_flag | Any | Any |
campaign_source_campaign_id | Any | Any |
campaign_spend_cap_amount | Any | Any |
campaign_spend_cap_automatic | Any | Any |
campaign_spend_cap_daily_cap | Any | Any |
campaign_spend_cap_type | Any | Any |
campaign_start_date (GMT) Campaign Start Date | Any | Any |
campaign_start_date_tz (CTZ) Campaign Start Date | Any | Any |
campaign_status Active Status | Any | Any |
campaign_suspicious_traffic_filter_level | Any | Any |
campaign_total_budget | Any | Any |
campaign_total_impression_budget Campaign Impressions Budget | Any | Any |
campaign_updated_on Campaign Update Time | Any | Any |
campaign_version | Any | Any |
campaign_zone_name Campaign Time Zone, a.k.a time_zone | Any | Any |
contextual_parent | Any | Any |
contextual_path | Any | Any |
contextual_target_id | Any | Any |
contextual_target_name | Any | Any |
contextual_vendor_name | Any | Any |
exchange_id | Any | Any |
exchange_name | Any | Any |
node_id | Any | Any |
organization_id | Any | Any |
organization_name | Any | Any |
strategy_ads_txt_verified | Any | Any |
strategy_archived | Any | Any |
strategy_audience_segment_exclude_op | Any | Any |
strategy_audience_segment_include_op | Any | Any |
strategy_bid_aggressiveness | Any | Any |
strategy_bid_min_devices | Any | Any |
strategy_bid_price_is_media_only | Any | Any |
strategy_budget | Any | Any |
strategy_cost_passthrough_cpm_enabled | Any | Any |
strategy_cost_passthrough_cpm_value | Any | Any |
strategy_cost_passthrough_percent_enabled | Any | Any |
strategy_cost_passthrough_percent_value | Any | Any |
strategy_created_on | Any | Any |
strategy_currency_code | Any | Any |
strategy_description | Any | Any |
strategy_device_graph_only | Any | Any |
strategy_end_date_raw | Any | Any |
strategy_exchange_type_for_run_on_all | Any | Any |
strategy_feature_compatibility | Any | Any |
strategy_frequency_amount | Any | Any |
strategy_frequency_interval Campaign Frequency Interval | Any | Any |
strategy_frequency_optimization | Any | Any |
strategy_frequency_type Campaign Frequency Type | Any | Any |
strategy_goal_type | Any | Any |
strategy_goal_value | Any | Any |
strategy_groups | Any | Any |
strategy_id | Any | Any |
strategy_impression_pacing_amount | Any | Any |
strategy_impression_pacing_interval | Any | Any |
strategy_impression_pacing_type | Any | Any |
strategy_max_bid | Any | Any |
strategy_max_bid_wm | Any | Any |
strategy_media_type | Any | Any |
strategy_min_bid | Any | Any |
strategy_name | Any | Any |
strategy_pacing_amount | Any | Any |
strategy_pacing_interval | Any | Any |
strategy_pacing_optimization_amount | Any | Any |
strategy_pacing_optimization_type | Any | Any |
strategy_pacing_type | Any | Any |
strategy_roi_target | Any | Any |
strategy_run_on_all_exchanges | Any | Any |
strategy_run_on_all_pmp | Any | Any |
strategy_run_on_display | Any | Any |
strategy_run_on_mobile | Any | Any |
strategy_run_on_only_fraud_filtered_exchanges | Any | Any |
strategy_run_on_streaming | Any | Any |
strategy_site_restriction_transparent_urls | Any | Any |
strategy_site_selectiveness | Any | Any |
strategy_source_only | Any | Any |
strategy_start_date_raw | Any | Any |
strategy_status Active Status | Any | Any |
strategy_supply_type | Any | Any |
strategy_targeting_segment_exclude_op | Any | Any |
strategy_targeting_segment_include_op | Any | Any |
strategy_type | Any | Any |
strategy_updated_on | Any | Any |
strategy_use_bid_shading | Any | Any |
strategy_use_campaign_end | Any | Any |
strategy_use_campaign_start | Any | Any |
strategy_use_dba_strategy_pacing | Any | Any |
strategy_use_dba_strategy_pacing_after_date | Any | Any |
strategy_use_mm_freq | Any | Any |
strategy_use_optimization | Any | Any |
strategy_version | Any | Any |
strategy_zone_name | Any | Any |
vendor_id | Any | Any |
Metrics | ||
clicks | Any | Any |
ctc CTC | Any | Any |
ctr CTR | Any | Any |
impressions | Any | Any |
media_cost_roi Media Cost ROI | Any | Any |
post_click_aov Post-Click AOV | Any | Any |
post_click_conversions Post-Click Conversions | Any | Any |
post_click_revenue Post-Click Revenue | Any | Any |
post_click_total_spend_roi Post-Click Total Spend ROI | Any | Any |
post_view_aov Post-View AOV | Any | Any |
post_view_conversions Post-View Conversions | Any | Any |
post_view_conversions_raw Post-View Conversions (Raw) | Any | Any |
post_view_revenue Post-View Revenue | Any | Any |
post_view_revenue_raw Post-View Revenue (Raw) | Any | Any |
post_view_total_spend_roi Post-View Total Spend ROI | Any | Any |
revenue_raw Revenue (Raw) | Any | Any |
rr_per_1k_imps Response Rate/1K Imps | Any | Any |
total_aov Total AOV | Any | Any |
total_conversions | Any | Any |
total_revenue | Any | Any |
total_spend | Any | Any |
total_spend_cpa Total Spend eCPA | Any | Any |
total_spend_cpc Total Spend eCPC | Any | Any |
total_spend_cpm Total Spend eCPM | Any | Any |
total_spend_pc_cpa Total Spend PC CPA | Any | Any |
total_spend_pv_cpa Total Spend PV CPA | Any | Any |
total_spend_roi Total Spend ROI | Any | Any |
Pageable
No
Time Windows
current_day
, last_X_days
, month_to_date
, yesterday
Rollups
all
, by_day
, by_month
, by_week
Data Retention / Lookback Window
30 days
=
: Equals or contains ifvalue
is an array!=
: Not equals>
: Greater than>=
: Greater than or equals<
: Less than<=
: Less than or equals=~
: Text contains (case-insensitive)and
: All filters must matchor
: At least one filter must match
- Live Server
https://api.mediamath.com/reporting/v2/contextual-insights
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.mediamath.com/reporting/v2/contextual-insights \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"end_time": "2019-08-24T14:15:22Z",
"fields": [
"string"
],
"filters": [
{
"field": "string",
"filters": [
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
},
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
}
],
"op": "=",
"value": 0
}
],
"full_entities": [
"string"
],
"order": [
{
"desc": false,
"field": "string",
"nulls_last": false
}
],
"rollup": "string",
"start_time": "2019-08-24T14:15:22Z",
"time_window": "string",
"time_zone": "string"
}'
"{\"fields\":[{\"name\":\"agg_timestamp\"},{\"name\":\"campaign_id\"},{\"name\":\"impressions\"}],\"total_items_count\":14}\n{\"campaign_id\":102461,\"impressions\":93283,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}\n{\"campaign_id\":1228153,\"impressions\":484,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}\n{\"campaign_id\":1245119,\"impressions\":0,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}"
Request
Standard performance metrics broken out by time of day and day of week. Available in standard intervals.
Fields
Field | Time Windows | Rollups |
---|---|---|
Dimensions | ||
agg_timestamp | campaign_to_date , current_day , last_X_days , month_to_date , yesterday | by_day , by_month , by_week |
advertiser_id | Any | Any |
advertiser_name | Any | Any |
agency_id | Any | Any |
agency_name | Any | Any |
attribution_group | Any | Any |
campaign_ads_txt_verified | Any | Any |
campaign_agency_fee_pct | Any | Any |
campaign_archived | Any | Any |
campaign_bid_min_devices | Any | Any |
campaign_brain_intraday_pacing | Any | Any |
campaign_connected_id_type | Any | Any |
campaign_conversion_type | Any | Any |
campaign_conversion_variable_minutes | Any | Any |
campaign_cost_passthrough_cpm_enabled | Any | Any |
campaign_cost_passthrough_cpm_value | Any | Any |
campaign_cost_passthrough_percent_enabled | Any | Any |
campaign_cost_passthrough_percent_value | Any | Any |
campaign_created_on Campaign Creation Time | Any | Any |
campaign_currency_code Campaign Currency Code | Any | Any |
campaign_custom_attribution_source | Any | Any |
campaign_dcs_data_is_campaign_level | Any | Any |
campaign_device_graph_only | Any | Any |
campaign_dynamic_budget_allocation_applied | Any | Any |
campaign_dynamic_budget_allocation_available | Any | Any |
campaign_dynamic_budget_allocation_type | Any | Any |
campaign_end_date (GMT) Campaign End Date | Any | Any |
campaign_end_date_tz (CTZ) Campaign End Date | Any | Any |
campaign_frequency_amount Campaign Frequency Amount | Any | Any |
campaign_frequency_interval Campaign Frequency Interval | Any | Any |
campaign_frequency_optimization Campaign Frequency Optimization | Any | Any |
campaign_frequency_type Campaign Frequency Type | Any | Any |
campaign_goal_alert | Any | Any |
campaign_goal_category | Any | Any |
campaign_goal_type | Any | Any |
campaign_goal_value | Any | Any |
campaign_has_custom_attribution | Any | Any |
campaign_id | Any | Any |
campaign_impression_cap_amount | Any | Any |
campaign_impression_cap_automatic | Any | Any |
campaign_impression_cap_type | Any | Any |
campaign_in_flight In Flight | Any | Any |
campaign_initial_start_date (GMT) Campaign Initial Start Date | Any | Any |
campaign_initial_start_date_tz (CTZ) Campaign Initial Start Date | Any | Any |
campaign_io_name | Any | Any |
campaign_io_reference_num | Any | Any |
campaign_is_programmatic_guaranteed Campaign Is Programmatic Guaranteed | Any | Any |
campaign_merit_pixel_id | Any | Any |
campaign_minimize_multi_ads Minimize Multi Ads | Any | Any |
campaign_name | Any | Any |
campaign_override_suspicious_traffic_filter | Any | Any |
campaign_pacing_alert | Any | Any |
campaign_pc_window_minutes | Any | Any |
campaign_political | Any | Any |
campaign_pv_pct | Any | Any |
campaign_pv_window_minutes | Any | Any |
campaign_restrict_targeting_to_deterministic_id | Any | Any |
campaign_restrict_targeting_to_same_device_id | Any | Any |
campaign_service_type Campaign Service Type, a.k.a. Managed Service Flag / managed_service_flag | Any | Any |
campaign_source_campaign_id | Any | Any |
campaign_spend_cap_amount | Any | Any |
campaign_spend_cap_automatic | Any | Any |
campaign_spend_cap_daily_cap | Any | Any |
campaign_spend_cap_type | Any | Any |
campaign_start_date (GMT) Campaign Start Date | Any | Any |
campaign_start_date_tz (CTZ) Campaign Start Date | Any | Any |
campaign_status Active Status | Any | Any |
campaign_suspicious_traffic_filter_level | Any | Any |
campaign_total_budget | Any | Any |
campaign_total_impression_budget Campaign Impressions Budget | Any | Any |
campaign_updated_on Campaign Update Time | Any | Any |
campaign_version | Any | Any |
campaign_zone_name Campaign Time Zone, a.k.a time_zone | Any | Any |
day_part_id Day Part ID | Any | Any |
day_part_name Day Part in the User's Timezone | Any | Any |
exchange_id | Any | Any |
exchange_name | Any | Any |
organization_id | Any | Any |
organization_name | Any | Any |
strategy_ads_txt_verified | Any | Any |
strategy_archived | Any | Any |
strategy_audience_segment_exclude_op | Any | Any |
strategy_audience_segment_include_op | Any | Any |
strategy_bid_aggressiveness | Any | Any |
strategy_bid_min_devices | Any | Any |
strategy_bid_price_is_media_only | Any | Any |
strategy_budget | Any | Any |
strategy_cost_passthrough_cpm_enabled | Any | Any |
strategy_cost_passthrough_cpm_value | Any | Any |
strategy_cost_passthrough_percent_enabled | Any | Any |
strategy_cost_passthrough_percent_value | Any | Any |
strategy_created_on | Any | Any |
strategy_currency_code | Any | Any |
strategy_description | Any | Any |
strategy_device_graph_only | Any | Any |
strategy_end_date_raw | Any | Any |
strategy_exchange_type_for_run_on_all | Any | Any |
strategy_feature_compatibility | Any | Any |
strategy_frequency_amount | Any | Any |
strategy_frequency_interval Campaign Frequency Interval | Any | Any |
strategy_frequency_optimization | Any | Any |
strategy_frequency_type Campaign Frequency Type | Any | Any |
strategy_goal_type | Any | Any |
strategy_goal_value | Any | Any |
strategy_groups | Any | Any |
strategy_id | Any | Any |
strategy_impression_pacing_amount | Any | Any |
strategy_impression_pacing_interval | Any | Any |
strategy_impression_pacing_type | Any | Any |
strategy_max_bid | Any | Any |
strategy_max_bid_wm | Any | Any |
strategy_media_type | Any | Any |
strategy_min_bid | Any | Any |
strategy_name | Any | Any |
strategy_pacing_amount | Any | Any |
strategy_pacing_interval | Any | Any |
strategy_pacing_optimization_amount | Any | Any |
strategy_pacing_optimization_type | Any | Any |
strategy_pacing_type | Any | Any |
strategy_roi_target | Any | Any |
strategy_run_on_all_exchanges | Any | Any |
strategy_run_on_all_pmp | Any | Any |
strategy_run_on_display | Any | Any |
strategy_run_on_mobile | Any | Any |
strategy_run_on_only_fraud_filtered_exchanges | Any | Any |
strategy_run_on_streaming | Any | Any |
strategy_site_restriction_transparent_urls | Any | Any |
strategy_site_selectiveness | Any | Any |
strategy_source_only | Any | Any |
strategy_start_date_raw | Any | Any |
strategy_status Active Status | Any | Any |
strategy_supply_type | Any | Any |
strategy_targeting_segment_exclude_op | Any | Any |
strategy_targeting_segment_include_op | Any | Any |
strategy_type | Any | Any |
strategy_updated_on | Any | Any |
strategy_use_bid_shading | Any | Any |
strategy_use_campaign_end | Any | Any |
strategy_use_campaign_start | Any | Any |
strategy_use_dba_strategy_pacing | Any | Any |
strategy_use_dba_strategy_pacing_after_date | Any | Any |
strategy_use_mm_freq | Any | Any |
strategy_use_optimization | Any | Any |
strategy_version | Any | Any |
strategy_zone_name | Any | Any |
week_day_id Weekday ID | Any | Any |
week_day_name | Any | Any |
Metrics | ||
clicks | Any | Any |
ctc CTC | Any | Any |
ctr CTR | Any | Any |
general_invalid_clicks | Any | Any |
impressions | Any | Any |
post_click_conversions Post-Click Conversions | Any | Any |
post_view_conversions Post-View Conversions | Any | Any |
rr_per_1k_imps Response Rate/1K Imps | Any | Any |
total_clicks | Any | Any |
total_conversions | Any | Any |
total_spend | Any | Any |
total_spend_cpa Total Spend eCPA | Any | Any |
total_spend_cpc Total Spend eCPC | Any | Any |
total_spend_cpcv Total Spend eCPCV | Any | Any |
total_spend_cpm Total Spend eCPM | Any | Any |
total_spend_pc_cpa Total Spend PC CPA | Any | Any |
total_spend_pv_cpa Total Spend PV CPA | Any | Any |
video_close Close | Any | Any |
video_collapse Collapse | Any | Any |
video_companion_clicks Companion Clicks | Any | Any |
video_companion_ctr Companion CTR | Any | Any |
video_companion_impressions Companion Impressions | Any | Any |
video_complete 100% Completed Views | Any | Any |
video_complete_rate 100% Completed Rate | Any | Any |
video_engaged_impressions Engaged Impressions | Any | Any |
video_engaged_rate Engaged Rate | Any | Any |
video_expand Expand | Any | Any |
video_first_quartile 25% Completed Views | Any | Any |
video_first_quartile_rate 25% Completed Rate | Any | Any |
video_fullscreen Fullscreen | Any | Any |
video_midpoint 50% Completed Views | Any | Any |
video_midpoint_rate 50% Completed Rate | Any | Any |
video_mute Mute | Any | Any |
video_pause Pause | Any | Any |
video_play_rate Play Rate | Any | Any |
video_resume Resume | Any | Any |
video_rewind Rewind | Any | Any |
video_skip Skip | Any | Any |
video_skippable_impressions Skippable Impressions | Any | Any |
video_skipped_impressions Skipped Impressions | Any | Any |
video_skipped_rate Skipped Rate | Any | Any |
video_start Start | Any | Any |
video_third_quartile 75% Completed Views | Any | Any |
video_third_quartile_rate 75% Completed Rate | Any | Any |
video_unmute Unmute | Any | Any |
Pageable
No
Time Windows
campaign_to_date
, current_day
, last_X_days
, month_to_date
, yesterday
Rollups
all
, by_day
, by_month
, by_week
Data Retention / Lookback Window
1 year and CTD
=
: Equals or contains ifvalue
is an array!=
: Not equals>
: Greater than>=
: Greater than or equals<
: Less than<=
: Less than or equals=~
: Text contains (case-insensitive)and
: All filters must matchor
: At least one filter must match
- Live Server
https://api.mediamath.com/reporting/v2/day-part
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.mediamath.com/reporting/v2/day-part \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"end_time": "2019-08-24T14:15:22Z",
"fields": [
"string"
],
"filters": [
{
"field": "string",
"filters": [
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
},
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
}
],
"op": "=",
"value": 0
}
],
"full_entities": [
"string"
],
"order": [
{
"desc": false,
"field": "string",
"nulls_last": false
}
],
"rollup": "string",
"start_time": "2019-08-24T14:15:22Z",
"time_window": "string",
"time_zone": "string"
}'
"{\"fields\":[{\"name\":\"agg_timestamp\"},{\"name\":\"campaign_id\"},{\"name\":\"impressions\"}],\"total_items_count\":14}\n{\"campaign_id\":102461,\"impressions\":93283,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}\n{\"campaign_id\":1228153,\"impressions\":484,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}\n{\"campaign_id\":1245119,\"impressions\":0,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}"
Request
Metrics that describe the path from a matched bid opportunity (biddable) to a delivered impression (win) for private marketplace deals. The data is stored in UTC timezone and is available by hour. In addition, the report updates on a 1 hour lag time at the top of the hour. For example, data from 1:00 – 1:59 AM will become available at roughly 3:00 AM.
Fields
Field | Time Windows | Rollups |
---|---|---|
Dimensions | ||
agg_timestamp | current_day , last_X_days , last_X_hours , month_to_date , yesterday | by_day , by_hour , by_month , by_week |
deal_exchange_id | Any | Any |
deal_external_id | Any | Any |
deal_group_id | Any | Any |
deal_group_name | Any | Any |
deal_id | Any | Any |
deal_name | Any | Any |
deal_organization_id | Any | Any |
deal_price_type | Any | Any |
deal_publisher_id Deal Publisher ID | Any | Any |
Metrics | ||
bid_rate | Any | Any |
biddables | Any | Any |
bids | Any | Any |
matches | Any | Any |
win_rate | Any | Any |
wins | Any | Any |
Pageable
No
Time Windows
current_day
, last_X_days
, last_X_hours
, month_to_date
, yesterday
Rollups
all
, by_day
, by_hour
, by_month
, by_week
Data Retention / Lookback Window
1 year
=
: Equals or contains ifvalue
is an array!=
: Not equals>
: Greater than>=
: Greater than or equals<
: Less than<=
: Less than or equals=~
: Text contains (case-insensitive)and
: All filters must matchor
: At least one filter must match
- Live Server
https://api.mediamath.com/reporting/v2/deals
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.mediamath.com/reporting/v2/deals \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"end_time": "2019-08-24T14:15:22Z",
"fields": [
"string"
],
"filters": [
{
"field": "string",
"filters": [
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
},
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
}
],
"op": "=",
"value": 0
}
],
"full_entities": [
"string"
],
"order": [
{
"desc": false,
"field": "string",
"nulls_last": false
}
],
"rollup": "string",
"start_time": "2019-08-24T14:15:22Z",
"time_window": "string",
"time_zone": "string"
}'
"{\"fields\":[{\"name\":\"agg_timestamp\"},{\"name\":\"campaign_id\"},{\"name\":\"impressions\"}],\"total_items_count\":14}\n{\"campaign_id\":102461,\"impressions\":93283,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}\n{\"campaign_id\":1228153,\"impressions\":484,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}\n{\"campaign_id\":1245119,\"impressions\":0,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}"
Request
Standard performance metrics broken out by Hyperlocal Targeting objects created via third party.
Fields
Field | Time Windows | Rollups |
---|---|---|
Dimensions | ||
agg_timestamp | current_day , last_X_days , month_to_date , yesterday | by_day , by_month , by_week |
advertiser_id | Any | Any |
advertiser_name | Any | Any |
agency_id | Any | Any |
agency_name | Any | Any |
attribution_group | Any | Any |
campaign_ads_txt_verified | Any | Any |
campaign_agency_fee_pct | Any | Any |
campaign_archived | Any | Any |
campaign_bid_min_devices | Any | Any |
campaign_brain_intraday_pacing | Any | Any |
campaign_connected_id_type | Any | Any |
campaign_conversion_type | Any | Any |
campaign_conversion_variable_minutes | Any | Any |
campaign_cost_passthrough_cpm_enabled | Any | Any |
campaign_cost_passthrough_cpm_value | Any | Any |
campaign_cost_passthrough_percent_enabled | Any | Any |
campaign_cost_passthrough_percent_value | Any | Any |
campaign_created_on Campaign Creation Time | Any | Any |
campaign_currency_code Campaign Currency Code | Any | Any |
campaign_custom_attribution_source | Any | Any |
campaign_dcs_data_is_campaign_level | Any | Any |
campaign_device_graph_only | Any | Any |
campaign_dynamic_budget_allocation_applied | Any | Any |
campaign_dynamic_budget_allocation_available | Any | Any |
campaign_dynamic_budget_allocation_type | Any | Any |
campaign_end_date (GMT) Campaign End Date | Any | Any |
campaign_end_date_tz (CTZ) Campaign End Date | Any | Any |
campaign_frequency_amount Campaign Frequency Amount | Any | Any |
campaign_frequency_interval Campaign Frequency Interval | Any | Any |
campaign_frequency_optimization Campaign Frequency Optimization | Any | Any |
campaign_frequency_type Campaign Frequency Type | Any | Any |
campaign_goal_alert | Any | Any |
campaign_goal_category | Any | Any |
campaign_goal_type | Any | Any |
campaign_goal_value | Any | Any |
campaign_has_custom_attribution | Any | Any |
campaign_id | Any | Any |
campaign_impression_cap_amount | Any | Any |
campaign_impression_cap_automatic | Any | Any |
campaign_impression_cap_type | Any | Any |
campaign_in_flight In Flight | Any | Any |
campaign_initial_start_date (GMT) Campaign Initial Start Date | Any | Any |
campaign_initial_start_date_tz (CTZ) Campaign Initial Start Date | Any | Any |
campaign_io_name | Any | Any |
campaign_io_reference_num | Any | Any |
campaign_is_programmatic_guaranteed Campaign Is Programmatic Guaranteed | Any | Any |
campaign_merit_pixel_id | Any | Any |
campaign_minimize_multi_ads Minimize Multi Ads | Any | Any |
campaign_name | Any | Any |
campaign_override_suspicious_traffic_filter | Any | Any |
campaign_pacing_alert | Any | Any |
campaign_pc_window_minutes | Any | Any |
campaign_political | Any | Any |
campaign_pv_pct | Any | Any |
campaign_pv_window_minutes | Any | Any |
campaign_restrict_targeting_to_deterministic_id | Any | Any |
campaign_restrict_targeting_to_same_device_id | Any | Any |
campaign_service_type Campaign Service Type, a.k.a. Managed Service Flag / managed_service_flag | Any | Any |
campaign_source_campaign_id | Any | Any |
campaign_spend_cap_amount | Any | Any |
campaign_spend_cap_automatic | Any | Any |
campaign_spend_cap_daily_cap | Any | Any |
campaign_spend_cap_type | Any | Any |
campaign_start_date (GMT) Campaign Start Date | Any | Any |
campaign_start_date_tz (CTZ) Campaign Start Date | Any | Any |
campaign_status Active Status | Any | Any |
campaign_suspicious_traffic_filter_level | Any | Any |
campaign_total_budget | Any | Any |
campaign_total_impression_budget Campaign Impressions Budget | Any | Any |
campaign_updated_on Campaign Update Time | Any | Any |
campaign_version | Any | Any |
campaign_zone_name Campaign Time Zone, a.k.a time_zone | Any | Any |
exchange_id | Any | Any |
exchange_name | Any | Any |
node_level | Any | Any |
organization_id | Any | Any |
organization_name | Any | Any |
path | Any | Any |
postal_code | Any | Any |
strategy_ads_txt_verified | Any | Any |
strategy_archived | Any | Any |
strategy_audience_segment_exclude_op | Any | Any |
strategy_audience_segment_include_op | Any | Any |
strategy_bid_aggressiveness | Any | Any |
strategy_bid_min_devices | Any | Any |
strategy_bid_price_is_media_only | Any | Any |
strategy_budget | Any | Any |
strategy_cost_passthrough_cpm_enabled | Any | Any |
strategy_cost_passthrough_cpm_value | Any | Any |
strategy_cost_passthrough_percent_enabled | Any | Any |
strategy_cost_passthrough_percent_value | Any | Any |
strategy_created_on | Any | Any |
strategy_currency_code | Any | Any |
strategy_description | Any | Any |
strategy_device_graph_only | Any | Any |
strategy_end_date_raw | Any | Any |
strategy_exchange_type_for_run_on_all | Any | Any |
strategy_feature_compatibility | Any | Any |
strategy_frequency_amount | Any | Any |
strategy_frequency_interval Campaign Frequency Interval | Any | Any |
strategy_frequency_optimization | Any | Any |
strategy_frequency_type Campaign Frequency Type | Any | Any |
strategy_goal_type | Any | Any |
strategy_goal_value | Any | Any |
strategy_groups | Any | Any |
strategy_id | Any | Any |
strategy_impression_pacing_amount | Any | Any |
strategy_impression_pacing_interval | Any | Any |
strategy_impression_pacing_type | Any | Any |
strategy_max_bid | Any | Any |
strategy_max_bid_wm | Any | Any |
strategy_media_type | Any | Any |
strategy_min_bid | Any | Any |
strategy_name | Any | Any |
strategy_pacing_amount | Any | Any |
strategy_pacing_interval | Any | Any |
strategy_pacing_optimization_amount | Any | Any |
strategy_pacing_optimization_type | Any | Any |
strategy_pacing_type | Any | Any |
strategy_roi_target | Any | Any |
strategy_run_on_all_exchanges | Any | Any |
strategy_run_on_all_pmp | Any | Any |
strategy_run_on_display | Any | Any |
strategy_run_on_mobile | Any | Any |
strategy_run_on_only_fraud_filtered_exchanges | Any | Any |
strategy_run_on_streaming | Any | Any |
strategy_site_restriction_transparent_urls | Any | Any |
strategy_site_selectiveness | Any | Any |
strategy_source_only | Any | Any |
strategy_start_date_raw | Any | Any |
strategy_status Active Status | Any | Any |
strategy_supply_type | Any | Any |
strategy_targeting_segment_exclude_op | Any | Any |
strategy_targeting_segment_include_op | Any | Any |
strategy_type | Any | Any |
strategy_updated_on | Any | Any |
strategy_use_bid_shading | Any | Any |
strategy_use_campaign_end | Any | Any |
strategy_use_campaign_start | Any | Any |
strategy_use_dba_strategy_pacing | Any | Any |
strategy_use_dba_strategy_pacing_after_date | Any | Any |
strategy_use_mm_freq | Any | Any |
strategy_use_optimization | Any | Any |
strategy_version | Any | Any |
strategy_zone_name | Any | Any |
target_id | Any | Any |
Metrics | ||
clicks | Any | Any |
ctc CTC | Any | Any |
ctr CTR | Any | Any |
general_invalid_clicks | Any | Any |
impressions | Any | Any |
media_cost_roi Media Cost ROI | Any | Any |
post_click_aov Post-Click AOV | Any | Any |
post_click_conversions Post-Click Conversions | Any | Any |
post_click_revenue Post-Click Revenue | Any | Any |
post_click_total_spend_roi Post-Click Total Spend ROI | Any | Any |
post_view_aov Post-View AOV | Any | Any |
post_view_conversions Post-View Conversions | Any | Any |
post_view_conversions_raw Post-View Conversions (Raw) | Any | Any |
post_view_revenue Post-View Revenue | Any | Any |
post_view_revenue_raw Post-View Revenue (Raw) | Any | Any |
post_view_total_spend_roi Post-View Total Spend ROI | Any | Any |
revenue_raw Revenue (Raw) | Any | Any |
rr_per_1k_imps Response Rate/1K Imps | Any | Any |
total_aov Total AOV | Any | Any |
total_clicks | Any | Any |
total_conversions | Any | Any |
total_revenue | Any | Any |
total_spend | Any | Any |
total_spend_cpa Total Spend eCPA | Any | Any |
total_spend_cpc Total Spend eCPC | Any | Any |
total_spend_cpm Total Spend eCPM | Any | Any |
total_spend_pc_cpa Total Spend PC CPA | Any | Any |
total_spend_pv_cpa Total Spend PV CPA | Any | Any |
total_spend_roi Total Spend ROI | Any | Any |
Pageable
No
Time Windows
current_day
, last_X_days
, month_to_date
, yesterday
Rollups
all
, by_day
, by_month
, by_week
Data Retention / Lookback Window
90 days
=
: Equals or contains ifvalue
is an array!=
: Not equals>
: Greater than>=
: Greater than or equals<
: Less than<=
: Less than or equals=~
: Text contains (case-insensitive)and
: All filters must matchor
: At least one filter must match
- Live Server
https://api.mediamath.com/reporting/v2/hyperlocal
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.mediamath.com/reporting/v2/hyperlocal \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"end_time": "2019-08-24T14:15:22Z",
"fields": [
"string"
],
"filters": [
{
"field": "string",
"filters": [
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
},
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
}
],
"op": "=",
"value": 0
}
],
"full_entities": [
"string"
],
"order": [
{
"desc": false,
"field": "string",
"nulls_last": false
}
],
"rollup": "string",
"start_time": "2019-08-24T14:15:22Z",
"time_window": "string",
"time_zone": "string"
}'
"{\"fields\":[{\"name\":\"agg_timestamp\"},{\"name\":\"campaign_id\"},{\"name\":\"impressions\"}],\"total_items_count\":14}\n{\"campaign_id\":102461,\"impressions\":93283,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}\n{\"campaign_id\":1228153,\"impressions\":484,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}\n{\"campaign_id\":1245119,\"impressions\":0,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}"
Request
Standard Aggregated Performance Report in Campaign Currency
Fields
Field | Time Windows | Rollups |
---|---|---|
Dimensions | ||
agg_timestamp | current_day , last_X_days , month_to_date , yesterday | by_day , by_month , by_week |
advertiser_id | Any | Any |
advertiser_name | Any | Any |
agency_id | Any | Any |
agency_name | Any | Any |
attribution_group | Any | Any |
campaign_ads_txt_verified | Any | Any |
campaign_agency_fee_pct | Any | Any |
campaign_archived | Any | Any |
campaign_bid_min_devices | Any | Any |
campaign_brain_intraday_pacing | Any | Any |
campaign_connected_id_type | Any | Any |
campaign_conversion_type | Any | Any |
campaign_conversion_variable_minutes | Any | Any |
campaign_cost_passthrough_cpm_enabled | Any | Any |
campaign_cost_passthrough_cpm_value | Any | Any |
campaign_cost_passthrough_percent_enabled | Any | Any |
campaign_cost_passthrough_percent_value | Any | Any |
campaign_created_on Campaign Creation Time | Any | Any |
campaign_currency_code Campaign Currency Code | Any | Any |
campaign_custom_attribution_source | Any | Any |
campaign_dcs_data_is_campaign_level | Any | Any |
campaign_device_graph_only | Any | Any |
campaign_dynamic_budget_allocation_applied | Any | Any |
campaign_dynamic_budget_allocation_available | Any | Any |
campaign_dynamic_budget_allocation_type | Any | Any |
campaign_end_date (GMT) Campaign End Date | Any | Any |
campaign_end_date_tz (CTZ) Campaign End Date | Any | Any |
campaign_frequency_amount Campaign Frequency Amount | Any | Any |
campaign_frequency_interval Campaign Frequency Interval | Any | Any |
campaign_frequency_optimization Campaign Frequency Optimization | Any | Any |
campaign_frequency_type Campaign Frequency Type | Any | Any |
campaign_goal_alert | Any | Any |
campaign_goal_category | Any | Any |
campaign_goal_type | Any | Any |
campaign_goal_value | Any | Any |
campaign_has_custom_attribution | Any | Any |
campaign_id | Any | Any |
campaign_impression_cap_amount | Any | Any |
campaign_impression_cap_automatic | Any | Any |
campaign_impression_cap_type | Any | Any |
campaign_in_flight In Flight | Any | Any |
campaign_initial_start_date (GMT) Campaign Initial Start Date | Any | Any |
campaign_initial_start_date_tz (CTZ) Campaign Initial Start Date | Any | Any |
campaign_io_name | Any | Any |
campaign_io_reference_num | Any | Any |
campaign_is_programmatic_guaranteed Campaign Is Programmatic Guaranteed | Any | Any |
campaign_merit_pixel_id | Any | Any |
campaign_minimize_multi_ads Minimize Multi Ads | Any | Any |
campaign_name | Any | Any |
campaign_override_suspicious_traffic_filter | Any | Any |
campaign_pacing_alert | Any | Any |
campaign_pc_window_minutes | Any | Any |
campaign_political | Any | Any |
campaign_pv_pct | Any | Any |
campaign_pv_window_minutes | Any | Any |
campaign_restrict_targeting_to_deterministic_id | Any | Any |
campaign_restrict_targeting_to_same_device_id | Any | Any |
campaign_service_type Campaign Service Type, a.k.a. Managed Service Flag / managed_service_flag | Any | Any |
campaign_source_campaign_id | Any | Any |
campaign_spend_cap_amount | Any | Any |
campaign_spend_cap_automatic | Any | Any |
campaign_spend_cap_daily_cap | Any | Any |
campaign_spend_cap_type | Any | Any |
campaign_start_date (GMT) Campaign Start Date | Any | Any |
campaign_start_date_tz (CTZ) Campaign Start Date | Any | Any |
campaign_status Active Status | Any | Any |
campaign_suspicious_traffic_filter_level | Any | Any |
campaign_total_budget | Any | Any |
campaign_total_impression_budget Campaign Impressions Budget | Any | Any |
campaign_updated_on Campaign Update Time | Any | Any |
campaign_version | Any | Any |
campaign_zone_name Campaign Time Zone, a.k.a time_zone | Any | Any |
concept_id | Any | Any |
concept_name | Any | Any |
creative_file_type | Any | Any |
creative_has_sound | Any | Any |
creative_id | Any | Any |
creative_is_native | Any | Any |
creative_name | Any | Any |
creative_rich_media | Any | Any |
creative_size | Any | Any |
creative_tpas_placement_id | Any | Any |
creative_tpas_placement_name | Any | Any |
deal_exchange_id | Any | Any |
deal_external_id | Any | Any |
deal_group_id | Any | Any |
deal_group_name | Any | Any |
deal_id | Any | Any |
deal_name | Any | Any |
deal_organization_id | Any | Any |
deal_price_type | Any | Any |
deal_publisher_id Deal Publisher ID | Any | Any |
exchange_id | Any | Any |
exchange_name | Any | Any |
flight_id | Any | Any |
organization_id | Any | Any |
organization_name | Any | Any |
prisma_campaign_id | Any | Any |
prisma_client_product_estimate | Any | Any |
prisma_io_number | Any | Any |
strategy_ads_txt_verified | Any | Any |
strategy_archived | Any | Any |
strategy_audience_segment_exclude_op | Any | Any |
strategy_audience_segment_include_op | Any | Any |
strategy_bid_aggressiveness | Any | Any |
strategy_bid_min_devices | Any | Any |
strategy_bid_price_is_media_only | Any | Any |
strategy_budget | Any | Any |
strategy_cost_passthrough_cpm_enabled | Any | Any |
strategy_cost_passthrough_cpm_value | Any | Any |
strategy_cost_passthrough_percent_enabled | Any | Any |
strategy_cost_passthrough_percent_value | Any | Any |
strategy_created_on | Any | Any |
strategy_currency_code | Any | Any |
strategy_description | Any | Any |
strategy_device_graph_only | Any | Any |
strategy_end_date_raw | Any | Any |
strategy_exchange_type_for_run_on_all | Any | Any |
strategy_feature_compatibility | Any | Any |
strategy_frequency_amount | Any | Any |
strategy_frequency_interval Campaign Frequency Interval | Any | Any |
strategy_frequency_optimization | Any | Any |
strategy_frequency_type Campaign Frequency Type | Any | Any |
strategy_goal_type | Any | Any |
strategy_goal_value | Any | Any |
strategy_groups | Any | Any |
strategy_id | Any | Any |
strategy_impression_pacing_amount | Any | Any |
strategy_impression_pacing_interval | Any | Any |
strategy_impression_pacing_type | Any | Any |
strategy_max_bid | Any | Any |
strategy_max_bid_wm | Any | Any |
strategy_media_type | Any | Any |
strategy_min_bid | Any | Any |
strategy_name | Any | Any |
strategy_pacing_amount | Any | Any |
strategy_pacing_interval | Any | Any |
strategy_pacing_optimization_amount | Any | Any |
strategy_pacing_optimization_type | Any | Any |
strategy_pacing_type | Any | Any |
strategy_roi_target | Any | Any |
strategy_run_on_all_exchanges | Any | Any |
strategy_run_on_all_pmp | Any | Any |
strategy_run_on_display | Any | Any |
strategy_run_on_mobile | Any | Any |
strategy_run_on_only_fraud_filtered_exchanges | Any | Any |
strategy_run_on_streaming | Any | Any |
strategy_site_restriction_transparent_urls | Any | Any |
strategy_site_selectiveness | Any | Any |
strategy_source_only | Any | Any |
strategy_start_date_raw | Any | Any |
strategy_status Active Status | Any | Any |
strategy_supply_type | Any | Any |
strategy_targeting_segment_exclude_op | Any | Any |
strategy_targeting_segment_include_op | Any | Any |
strategy_type | Any | Any |
strategy_updated_on | Any | Any |
strategy_use_bid_shading | Any | Any |
strategy_use_campaign_end | Any | Any |
strategy_use_campaign_start | Any | Any |
strategy_use_dba_strategy_pacing | Any | Any |
strategy_use_dba_strategy_pacing_after_date | Any | Any |
strategy_use_mm_freq | Any | Any |
strategy_use_optimization | Any | Any |
strategy_version | Any | Any |
strategy_zone_name | Any | Any |
Metrics | ||
clicks | Any | Any |
ctc CTC | Any | Any |
ctr CTR | Any | Any |
general_invalid_clicks | Any | Any |
impressions | Any | Any |
in_view In View Impressions | Any | Any |
in_view_100_percent 100% In View Impressions | Any | Any |
in_view_15_seconds | Any | Any |
in_view_15_seconds_rate | Any | Any |
in_view_5_seconds | Any | Any |
in_view_5_seconds_rate | Any | Any |
measurability_rate Measurability Rate | Any | Any |
measurable Measurable Impressions | Any | Any |
post_click_aov Post-Click AOV | Any | Any |
post_click_conversions Post-Click Conversions | Any | Any |
post_click_revenue Post-Click Revenue | Any | Any |
post_click_revenue_usd | Any | Any |
post_click_total_spend_roi Post-Click Total Spend ROI | Any | Any |
post_view_aov Post-View AOV | Any | Any |
post_view_conversions Post-View Conversions | Any | Any |
post_view_conversions_raw Post-View Conversions (Raw) | Any | Any |
post_view_revenue Post-View Revenue | Any | Any |
post_view_revenue_raw Post-View Revenue (Raw) | Any | Any |
post_view_revenue_raw_usd | Any | Any |
post_view_total_spend_roi Post-View Total Spend ROI | Any | Any |
revenue Revenue (Raw) | Any | Any |
rr_per_1k_imps Response Rate/1K Imps | Any | Any |
total_aov Total AOV | Any | Any |
total_clicks | Any | Any |
total_conversions | Any | Any |
total_revenue | Any | Any |
total_spend | Any | Any |
total_spend_cpa Total Spend eCPA | Any | Any |
total_spend_cpc Total Spend eCPC | Any | Any |
total_spend_cpcv Total Spend eCPCV | Any | Any |
total_spend_cpm Total Spend eCPM | Any | Any |
total_spend_pc_cpa Total Spend PC CPA | Any | Any |
total_spend_pv_cpa Total Spend PV CPA | Any | Any |
total_spend_roi Total Spend ROI | Any | Any |
total_spend_usd | Any | Any |
total_spend_vcpm Total Spend vCPM | Any | Any |
tpa_conversions 3PA Total Conversions | Any | Any |
tpa_total_aov 3PA Total AOV | Any | Any |
tpa_total_aov_usd (USD) 3PA Total AOV | Any | Any |
tpa_total_revenue 3PA Total Revenue | Any | Any |
tpa_total_revenue_usd (USD) 3PA Total Revenue | Any | Any |
tpa_total_spend_cpa 3PA Total Spend CPA | Any | Any |
tpa_total_spend_cpa_usd (USD) 3PA Total Spend CPA | Any | Any |
tpa_total_spend_roi 3PA Total Spend ROI | Any | Any |
uniques | current_day , last_X_days , month_to_date , yesterday | all , by_day , by_month , by_week |
video_close Close | Any | Any |
video_collapse Collapse | Any | Any |
video_companion_clicks Companion Clicks | Any | Any |
video_companion_ctr Companion CTR | Any | Any |
video_companion_impressions Companion Impressions | Any | Any |
video_complete 100% Completed Views | Any | Any |
video_complete_rate 100% Completed Rate | Any | Any |
video_complete_rate_impression_based VCR (Impression Based) | Any | Any |
video_engaged_impressions Engaged Impressions | Any | Any |
video_engaged_rate Engaged Rate | Any | Any |
video_expand Expand | Any | Any |
video_first_quartile 25% Completed Views | Any | Any |
video_first_quartile_rate 25% Completed Rate | Any | Any |
video_first_quartile_rate_impression_based 25% Completed Rate - Impressions Based | Any | Any |
video_fullscreen Fullscreen | Any | Any |
video_midpoint 50% Completed Views | Any | Any |
video_midpoint_rate 50% Completed Rate | Any | Any |
video_midpoint_rate_impression_based 50% Completed Rate - Impressions Based | Any | Any |
video_mute | Any | Any |
video_pause Pause | Any | Any |
video_play_rate Play Rate | Any | Any |
video_resume Resume | Any | Any |
video_rewind Rewind | Any | Any |
video_skip Skip | Any | Any |
video_skippable_impressions Skippable Impressions | Any | Any |
video_skipped_impressions Skipped Impressions | Any | Any |
video_skipped_rate Skipped Rate | Any | Any |
video_start Start | Any | Any |
video_third_quartile 75% Completed Views | Any | Any |
video_third_quartile_rate 75% Completed Rate | Any | Any |
video_third_quartile_rate_impression_based 75% Completed Rate - Impressions Based | Any | Any |
video_unmute | Any | Any |
viewability_rate Viewability Rate | Any | Any |
viewability_rate_100_percent 100% In View Rate | Any | Any |
Pageable
No
Time Windows
current_day
, last_X_days
, month_to_date
, yesterday
Rollups
all
, by_day
, by_month
, by_week
Data Retention / Lookback Window
Since 2013
=
: Equals or contains ifvalue
is an array!=
: Not equals>
: Greater than>=
: Greater than or equals<
: Less than<=
: Less than or equals=~
: Text contains (case-insensitive)and
: All filters must matchor
: At least one filter must match
- Live Server
https://api.mediamath.com/reporting/v2/performance
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.mediamath.com/reporting/v2/performance \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"end_time": "2019-08-24T14:15:22Z",
"fields": [
"string"
],
"filters": [
{
"field": "string",
"filters": [
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
},
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
}
],
"op": "=",
"value": 0
}
],
"full_entities": [
"string"
],
"order": [
{
"desc": false,
"field": "string",
"nulls_last": false
}
],
"rollup": "string",
"start_time": "2019-08-24T14:15:22Z",
"time_window": "string",
"time_zone": "string"
}'
"{\"fields\":[{\"name\":\"agg_timestamp\"},{\"name\":\"campaign_id\"},{\"name\":\"impressions\"}],\"total_items_count\":14}\n{\"campaign_id\":102461,\"impressions\":93283,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}\n{\"campaign_id\":1228153,\"impressions\":484,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}\n{\"campaign_id\":1245119,\"impressions\":0,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}"
Request
Standard Aggregated Performance Report in Campaign Currency
Fields
Field | Time Windows | Rollups |
---|---|---|
Dimensions | ||
agg_timestamp | current_day , last_X_days , last_X_hours , month_to_date , yesterday | by_day , by_hour , by_month , by_week |
advertiser_id | Any | Any |
advertiser_name | Any | Any |
agency_id | Any | Any |
agency_name | Any | Any |
campaign_ads_txt_verified | Any | Any |
campaign_agency_fee_pct | Any | Any |
campaign_archived | Any | Any |
campaign_bid_min_devices | Any | Any |
campaign_brain_intraday_pacing | Any | Any |
campaign_connected_id_type | Any | Any |
campaign_conversion_type | Any | Any |
campaign_conversion_variable_minutes | Any | Any |
campaign_cost_passthrough_cpm_enabled | Any | Any |
campaign_cost_passthrough_cpm_value | Any | Any |
campaign_cost_passthrough_percent_enabled | Any | Any |
campaign_cost_passthrough_percent_value | Any | Any |
campaign_created_on Campaign Creation Time | Any | Any |
campaign_currency_code Campaign Currency Code | Any | Any |
campaign_custom_attribution_source | Any | Any |
campaign_dcs_data_is_campaign_level | Any | Any |
campaign_device_graph_only | Any | Any |
campaign_dynamic_budget_allocation_applied | Any | Any |
campaign_dynamic_budget_allocation_available | Any | Any |
campaign_dynamic_budget_allocation_type | Any | Any |
campaign_end_date (GMT) Campaign End Date | Any | Any |
campaign_end_date_tz (CTZ) Campaign End Date | Any | Any |
campaign_frequency_amount Campaign Frequency Amount | Any | Any |
campaign_frequency_interval Campaign Frequency Interval | Any | Any |
campaign_frequency_optimization Campaign Frequency Optimization | Any | Any |
campaign_frequency_type Campaign Frequency Type | Any | Any |
campaign_goal_alert | Any | Any |
campaign_goal_category | Any | Any |
campaign_goal_type | Any | Any |
campaign_goal_value | Any | Any |
campaign_has_custom_attribution | Any | Any |
campaign_id | Any | Any |
campaign_impression_cap_amount | Any | Any |
campaign_impression_cap_automatic | Any | Any |
campaign_impression_cap_type | Any | Any |
campaign_in_flight In Flight | Any | Any |
campaign_initial_start_date (GMT) Campaign Initial Start Date | Any | Any |
campaign_initial_start_date_tz (CTZ) Campaign Initial Start Date | Any | Any |
campaign_io_name | Any | Any |
campaign_io_reference_num | Any | Any |
campaign_is_programmatic_guaranteed Campaign Is Programmatic Guaranteed | Any | Any |
campaign_merit_pixel_id | Any | Any |
campaign_minimize_multi_ads Minimize Multi Ads | Any | Any |
campaign_name | Any | Any |
campaign_override_suspicious_traffic_filter | Any | Any |
campaign_pacing_alert | Any | Any |
campaign_pc_window_minutes | Any | Any |
campaign_political | Any | Any |
campaign_pv_pct | Any | Any |
campaign_pv_window_minutes | Any | Any |
campaign_restrict_targeting_to_deterministic_id | Any | Any |
campaign_restrict_targeting_to_same_device_id | Any | Any |
campaign_service_type Campaign Service Type, a.k.a. Managed Service Flag / managed_service_flag | Any | Any |
campaign_source_campaign_id | Any | Any |
campaign_spend_cap_amount | Any | Any |
campaign_spend_cap_automatic | Any | Any |
campaign_spend_cap_daily_cap | Any | Any |
campaign_spend_cap_type | Any | Any |
campaign_start_date (GMT) Campaign Start Date | Any | Any |
campaign_start_date_tz (CTZ) Campaign Start Date | Any | Any |
campaign_status Active Status | Any | Any |
campaign_suspicious_traffic_filter_level | Any | Any |
campaign_total_budget | Any | Any |
campaign_total_impression_budget Campaign Impressions Budget | Any | Any |
campaign_updated_on Campaign Update Time | Any | Any |
campaign_version | Any | Any |
campaign_zone_name Campaign Time Zone, a.k.a time_zone | Any | Any |
flight_id | Any | Any |
organization_id | Any | Any |
organization_name | Any | Any |
prisma_campaign_id | Any | Any |
prisma_client_product_estimate | Any | Any |
prisma_io_number | Any | Any |
strategy_ads_txt_verified | Any | Any |
strategy_archived | Any | Any |
strategy_audience_segment_exclude_op | Any | Any |
strategy_audience_segment_include_op | Any | Any |
strategy_bid_aggressiveness | Any | Any |
strategy_bid_min_devices | Any | Any |
strategy_bid_price_is_media_only | Any | Any |
strategy_budget | Any | Any |
strategy_cost_passthrough_cpm_enabled | Any | Any |
strategy_cost_passthrough_cpm_value | Any | Any |
strategy_cost_passthrough_percent_enabled | Any | Any |
strategy_cost_passthrough_percent_value | Any | Any |
strategy_created_on | Any | Any |
strategy_currency_code | Any | Any |
strategy_description | Any | Any |
strategy_device_graph_only | Any | Any |
strategy_end_date_raw | Any | Any |
strategy_exchange_type_for_run_on_all | Any | Any |
strategy_feature_compatibility | Any | Any |
strategy_frequency_amount | Any | Any |
strategy_frequency_interval Campaign Frequency Interval | Any | Any |
strategy_frequency_optimization | Any | Any |
strategy_frequency_type Campaign Frequency Type | Any | Any |
strategy_goal_type | Any | Any |
strategy_goal_value | Any | Any |
strategy_groups | Any | Any |
strategy_id | Any | Any |
strategy_impression_pacing_amount | Any | Any |
strategy_impression_pacing_interval | Any | Any |
strategy_impression_pacing_type | Any | Any |
strategy_max_bid | Any | Any |
strategy_max_bid_wm | Any | Any |
strategy_media_type | Any | Any |
strategy_min_bid | Any | Any |
strategy_name | Any | Any |
strategy_pacing_amount | Any | Any |
strategy_pacing_interval | Any | Any |
strategy_pacing_optimization_amount | Any | Any |
strategy_pacing_optimization_type | Any | Any |
strategy_pacing_type | Any | Any |
strategy_roi_target | Any | Any |
strategy_run_on_all_exchanges | Any | Any |
strategy_run_on_all_pmp | Any | Any |
strategy_run_on_display | Any | Any |
strategy_run_on_mobile | Any | Any |
strategy_run_on_only_fraud_filtered_exchanges | Any | Any |
strategy_run_on_streaming | Any | Any |
strategy_site_restriction_transparent_urls | Any | Any |
strategy_site_selectiveness | Any | Any |
strategy_source_only | Any | Any |
strategy_start_date_raw | Any | Any |
strategy_status Active Status | Any | Any |
strategy_supply_type | Any | Any |
strategy_targeting_segment_exclude_op | Any | Any |
strategy_targeting_segment_include_op | Any | Any |
strategy_type | Any | Any |
strategy_updated_on | Any | Any |
strategy_use_bid_shading | Any | Any |
strategy_use_campaign_end | Any | Any |
strategy_use_campaign_start | Any | Any |
strategy_use_dba_strategy_pacing | Any | Any |
strategy_use_dba_strategy_pacing_after_date | Any | Any |
strategy_use_mm_freq | Any | Any |
strategy_use_optimization | Any | Any |
strategy_version | Any | Any |
strategy_zone_name | Any | Any |
Metrics | ||
clicks | Any | Any |
ctc CTC | Any | Any |
ctr CTR | Any | Any |
general_invalid_clicks | Any | Any |
impressions | Any | Any |
in_view In View Impressions | Any | Any |
in_view_100_percent 100% In View Impressions | Any | Any |
in_view_15_seconds | Any | Any |
in_view_15_seconds_rate | Any | Any |
in_view_5_seconds | Any | Any |
in_view_5_seconds_rate | Any | Any |
measurability_rate Measurability Rate | Any | Any |
measurable Measurable Impressions | Any | Any |
post_click_aov Post-Click AOV | Any | Any |
post_click_conversions Post-Click Conversions | Any | Any |
post_click_revenue Post-Click Revenue | Any | Any |
post_click_revenue_usd | Any | Any |
post_click_total_spend_roi Post-Click Total Spend ROI | Any | Any |
post_view_aov Post-View AOV | Any | Any |
post_view_conversions Post-View Conversions | Any | Any |
post_view_conversions_raw Post-View Conversions (Raw) | Any | Any |
post_view_revenue Post-View Revenue | Any | Any |
post_view_revenue_raw Post-View Revenue (Raw) | Any | Any |
post_view_revenue_raw_usd | Any | Any |
post_view_total_spend_roi Post-View Total Spend ROI | Any | Any |
revenue Revenue (Raw) | Any | Any |
rr_per_1k_imps Response Rate/1K Imps | Any | Any |
total_aov Total AOV | Any | Any |
total_clicks | Any | Any |
total_conversions | Any | Any |
total_revenue | Any | Any |
total_spend | Any | Any |
total_spend_cpa Total Spend eCPA | Any | Any |
total_spend_cpc Total Spend eCPC | Any | Any |
total_spend_cpcv Total Spend eCPCV | Any | Any |
total_spend_cpm Total Spend eCPM | Any | Any |
total_spend_pc_cpa Total Spend PC CPA | Any | Any |
total_spend_pv_cpa Total Spend PV CPA | Any | Any |
total_spend_roi Total Spend ROI | Any | Any |
total_spend_usd | Any | Any |
total_spend_vcpm Total Spend vCPM | Any | Any |
tpa_conversions 3PA Total Conversions | Any | Any |
tpa_total_aov 3PA Total AOV | Any | Any |
tpa_total_aov_usd (USD) 3PA Total AOV | Any | Any |
tpa_total_revenue 3PA Total Revenue | Any | Any |
tpa_total_revenue_usd (USD) 3PA Total Revenue | Any | Any |
tpa_total_spend_cpa 3PA Total Spend CPA | Any | Any |
tpa_total_spend_cpa_usd (USD) 3PA Total Spend CPA | Any | Any |
tpa_total_spend_roi 3PA Total Spend ROI | Any | Any |
video_close Close | Any | Any |
video_collapse Collapse | Any | Any |
video_companion_clicks Companion Clicks | Any | Any |
video_companion_ctr Companion CTR | Any | Any |
video_companion_impressions Companion Impressions | Any | Any |
video_complete 100% Completed Views | Any | Any |
video_complete_rate 100% Completed Rate | Any | Any |
video_complete_rate_impression_based VCR (Impression Based) | Any | Any |
video_engaged_impressions Engaged Impressions | Any | Any |
video_engaged_rate Engaged Rate | Any | Any |
video_expand Expand | Any | Any |
video_first_quartile 25% Completed Views | Any | Any |
video_first_quartile_rate 25% Completed Rate | Any | Any |
video_first_quartile_rate_impression_based 25% Completed Rate - Impressions Based | Any | Any |
video_fullscreen Fullscreen | Any | Any |
video_midpoint 50% Completed Views | Any | Any |
video_midpoint_rate 50% Completed Rate | Any | Any |
video_midpoint_rate_impression_based 50% Completed Rate - Impressions Based | Any | Any |
video_mute | Any | Any |
video_pause Pause | Any | Any |
video_play_rate Play Rate | Any | Any |
video_resume Resume | Any | Any |
video_rewind Rewind | Any | Any |
video_skip Skip | Any | Any |
video_skippable_impressions Skippable Impressions | Any | Any |
video_skipped_impressions Skipped Impressions | Any | Any |
video_skipped_rate Skipped Rate | Any | Any |
video_start Start | Any | Any |
video_third_quartile 75% Completed Views | Any | Any |
video_third_quartile_rate 75% Completed Rate | Any | Any |
video_third_quartile_rate_impression_based 75% Completed Rate - Impressions Based | Any | Any |
video_unmute | Any | Any |
viewability_rate Viewability Rate | Any | Any |
viewability_rate_100_percent 100% In View Rate | Any | Any |
Pageable
No
Time Windows
current_day
, last_X_days
, last_X_hours
, month_to_date
, yesterday
Rollups
all
, by_day
, by_hour
, by_month
, by_week
Data Retention / Lookback Window
90 days
Time Zones
UTC
, campaign
=
: Equals or contains ifvalue
is an array!=
: Not equals>
: Greater than>=
: Greater than or equals<
: Less than<=
: Less than or equals=~
: Text contains (case-insensitive)and
: All filters must matchor
: At least one filter must match
- Live Server
https://api.mediamath.com/reporting/v2/performance-hourly
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.mediamath.com/reporting/v2/performance-hourly \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"end_time": "2019-08-24T14:15:22Z",
"fields": [
"string"
],
"filters": [
{
"field": "string",
"filters": [
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
},
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
}
],
"op": "=",
"value": 0
}
],
"full_entities": [
"string"
],
"order": [
{
"desc": false,
"field": "string",
"nulls_last": false
}
],
"rollup": "string",
"start_time": "2019-08-24T14:15:22Z",
"time_window": "string",
"time_zone": "string"
}'
"{\"fields\":[{\"name\":\"agg_timestamp\"},{\"name\":\"campaign_id\"},{\"name\":\"impressions\"}],\"total_items_count\":14}\n{\"campaign_id\":102461,\"impressions\":93283,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}\n{\"campaign_id\":1228153,\"impressions\":484,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}\n{\"campaign_id\":1245119,\"impressions\":0,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}"
Request
Loads and Uniques metrics for data
and event
pixels, broken out by referrer and referrer rank, available by day.
Fields
Field | Time Windows | Rollups |
---|---|---|
Dimensions | ||
agg_timestamp | current_day , last_X_days , month_to_date , yesterday | by_day , by_month , by_week |
advertiser_name | Any | Any |
agency_id | Any | Any |
agency_name | Any | Any |
organization_id | Any | Any |
pixel_advertiser_id | Any | Any |
pixel_cost_cpm | Any | Any |
pixel_cost_cpts | Any | Any |
pixel_cost_pct_cpm | Any | Any |
pixel_created_on Pixel Creation Time | Any | Any |
pixel_currency | Any | Any |
pixel_currency_fixed | Any | Any |
pixel_eligible | Any | Any |
pixel_external_identifier | Any | Any |
pixel_id | Any | Any |
pixel_name | Any | Any |
pixel_pricing | Any | Any |
pixel_provider_created_on | Any | Any |
pixel_provider_execution_by | Any | Any |
pixel_provider_id | Any | Any |
pixel_provider_name | Any | Any |
pixel_provider_provider_tax | Any | Any |
pixel_provider_status | Any | Any |
pixel_provider_taxonomy_file | Any | Any |
pixel_provider_updated_on | Any | Any |
pixel_provider_vendor_id | Any | Any |
pixel_provider_version | Any | Any |
pixel_rmx_conversion_minutes | Any | Any |
pixel_rmx_conversion_type | Any | Any |
pixel_rmx_friendly | Any | Any |
pixel_rmx_merit | Any | Any |
pixel_rmx_pc_window_minutes | Any | Any |
pixel_rmx_pv_window_minutes | Any | Any |
pixel_segment_op | Any | Any |
pixel_status | Any | Any |
pixel_tag_type | Any | Any |
pixel_tags | Any | Any |
pixel_type | Any | Any |
pixel_updated_on Pixel Update Time | Any | Any |
provider_id | Any | Any |
referrer | Any | Any |
referrer_rank | Any | Any |
Metrics | ||
loads | Any | Any |
uniques | Any | Any |
Pageable
Yes
Time Windows
current_day
, last_X_days
, month_to_date
, yesterday
Rollups
all
, by_day
, by_month
, by_week
Data Retention / Lookback Window
90 days
=
: Equals or contains ifvalue
is an array!=
: Not equals>
: Greater than>=
: Greater than or equals<
: Less than<=
: Less than or equals=~
: Text contains (case-insensitive)and
: All filters must matchor
: At least one filter must match
- Live Server
https://api.mediamath.com/reporting/v2/pixel-loads
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.mediamath.com/reporting/v2/pixel-loads \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"end_time": "2019-08-24T14:15:22Z",
"fields": [
"string"
],
"filters": [
{
"field": "string",
"filters": [
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
},
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
}
],
"op": "=",
"value": 0
}
],
"full_entities": [
"string"
],
"order": [
{
"desc": false,
"field": "string",
"nulls_last": false
}
],
"pagination": {
"page_index": 0,
"page_size": 1
},
"rollup": "string",
"start_time": "2019-08-24T14:15:22Z",
"time_window": "string",
"time_zone": "string"
}'
{ "meta": { "items_count": 0, "page_index": 0, "status": "ok", "total_items_count": 0, "total_pages": 0 }, "results": [ {} ] }
Request
Standard performance metrics broken out by postal code. Only includes data for strategies that targeted or anti-targeted postal codes. Available in custom date ranges or intervals with the option to aggregate by day, week, or month.
Fields
Field | Time Windows | Rollups |
---|---|---|
Dimensions | ||
agg_timestamp | current_day , last_X_days , month_to_date , yesterday | by_day , by_month , by_week |
advertiser_id | Any | Any |
advertiser_name | Any | Any |
agency_id | Any | Any |
agency_name | Any | Any |
attribution_group | Any | Any |
campaign_ads_txt_verified | Any | Any |
campaign_agency_fee_pct | Any | Any |
campaign_archived | Any | Any |
campaign_bid_min_devices | Any | Any |
campaign_brain_intraday_pacing | Any | Any |
campaign_connected_id_type | Any | Any |
campaign_conversion_type | Any | Any |
campaign_conversion_variable_minutes | Any | Any |
campaign_cost_passthrough_cpm_enabled | Any | Any |
campaign_cost_passthrough_cpm_value | Any | Any |
campaign_cost_passthrough_percent_enabled | Any | Any |
campaign_cost_passthrough_percent_value | Any | Any |
campaign_created_on Campaign Creation Time | Any | Any |
campaign_currency_code Campaign Currency Code | Any | Any |
campaign_custom_attribution_source | Any | Any |
campaign_dcs_data_is_campaign_level | Any | Any |
campaign_device_graph_only | Any | Any |
campaign_dynamic_budget_allocation_applied | Any | Any |
campaign_dynamic_budget_allocation_available | Any | Any |
campaign_dynamic_budget_allocation_type | Any | Any |
campaign_end_date (GMT) Campaign End Date | Any | Any |
campaign_end_date_tz (CTZ) Campaign End Date | Any | Any |
campaign_frequency_amount Campaign Frequency Amount | Any | Any |
campaign_frequency_interval Campaign Frequency Interval | Any | Any |
campaign_frequency_optimization Campaign Frequency Optimization | Any | Any |
campaign_frequency_type Campaign Frequency Type | Any | Any |
campaign_goal_alert | Any | Any |
campaign_goal_category | Any | Any |
campaign_goal_type | Any | Any |
campaign_goal_value | Any | Any |
campaign_has_custom_attribution | Any | Any |
campaign_id | Any | Any |
campaign_impression_cap_amount | Any | Any |
campaign_impression_cap_automatic | Any | Any |
campaign_impression_cap_type | Any | Any |
campaign_in_flight In Flight | Any | Any |
campaign_initial_start_date (GMT) Campaign Initial Start Date | Any | Any |
campaign_initial_start_date_tz (CTZ) Campaign Initial Start Date | Any | Any |
campaign_io_name | Any | Any |
campaign_io_reference_num | Any | Any |
campaign_is_programmatic_guaranteed Campaign Is Programmatic Guaranteed | Any | Any |
campaign_merit_pixel_id | Any | Any |
campaign_minimize_multi_ads Minimize Multi Ads | Any | Any |
campaign_name | Any | Any |
campaign_override_suspicious_traffic_filter | Any | Any |
campaign_pacing_alert | Any | Any |
campaign_pc_window_minutes | Any | Any |
campaign_political | Any | Any |
campaign_pv_pct | Any | Any |
campaign_pv_window_minutes | Any | Any |
campaign_restrict_targeting_to_deterministic_id | Any | Any |
campaign_restrict_targeting_to_same_device_id | Any | Any |
campaign_service_type Campaign Service Type, a.k.a. Managed Service Flag / managed_service_flag | Any | Any |
campaign_source_campaign_id | Any | Any |
campaign_spend_cap_amount | Any | Any |
campaign_spend_cap_automatic | Any | Any |
campaign_spend_cap_daily_cap | Any | Any |
campaign_spend_cap_type | Any | Any |
campaign_start_date (GMT) Campaign Start Date | Any | Any |
campaign_start_date_tz (CTZ) Campaign Start Date | Any | Any |
campaign_status Active Status | Any | Any |
campaign_suspicious_traffic_filter_level | Any | Any |
campaign_total_budget | Any | Any |
campaign_total_impression_budget Campaign Impressions Budget | Any | Any |
campaign_updated_on Campaign Update Time | Any | Any |
campaign_version | Any | Any |
campaign_zone_name Campaign Time Zone, a.k.a time_zone | Any | Any |
exchange_id | Any | Any |
exchange_name | Any | Any |
organization_id | Any | Any |
organization_name | Any | Any |
postal_code | Any | Any |
strategy_ads_txt_verified | Any | Any |
strategy_archived | Any | Any |
strategy_audience_segment_exclude_op | Any | Any |
strategy_audience_segment_include_op | Any | Any |
strategy_bid_aggressiveness | Any | Any |
strategy_bid_min_devices | Any | Any |
strategy_bid_price_is_media_only | Any | Any |
strategy_budget | Any | Any |
strategy_cost_passthrough_cpm_enabled | Any | Any |
strategy_cost_passthrough_cpm_value | Any | Any |
strategy_cost_passthrough_percent_enabled | Any | Any |
strategy_cost_passthrough_percent_value | Any | Any |
strategy_created_on | Any | Any |
strategy_currency_code | Any | Any |
strategy_description | Any | Any |
strategy_device_graph_only | Any | Any |
strategy_end_date_raw | Any | Any |
strategy_exchange_type_for_run_on_all | Any | Any |
strategy_feature_compatibility | Any | Any |
strategy_frequency_amount | Any | Any |
strategy_frequency_interval Campaign Frequency Interval | Any | Any |
strategy_frequency_optimization | Any | Any |
strategy_frequency_type Campaign Frequency Type | Any | Any |
strategy_goal_type | Any | Any |
strategy_goal_value | Any | Any |
strategy_groups | Any | Any |
strategy_id | Any | Any |
strategy_impression_pacing_amount | Any | Any |
strategy_impression_pacing_interval | Any | Any |
strategy_impression_pacing_type | Any | Any |
strategy_max_bid | Any | Any |
strategy_max_bid_wm | Any | Any |
strategy_media_type | Any | Any |
strategy_min_bid | Any | Any |
strategy_name | Any | Any |
strategy_pacing_amount | Any | Any |
strategy_pacing_interval | Any | Any |
strategy_pacing_optimization_amount | Any | Any |
strategy_pacing_optimization_type | Any | Any |
strategy_pacing_type | Any | Any |
strategy_roi_target | Any | Any |
strategy_run_on_all_exchanges | Any | Any |
strategy_run_on_all_pmp | Any | Any |
strategy_run_on_display | Any | Any |
strategy_run_on_mobile | Any | Any |
strategy_run_on_only_fraud_filtered_exchanges | Any | Any |
strategy_run_on_streaming | Any | Any |
strategy_site_restriction_transparent_urls | Any | Any |
strategy_site_selectiveness | Any | Any |
strategy_source_only | Any | Any |
strategy_start_date_raw | Any | Any |
strategy_status Active Status | Any | Any |
strategy_supply_type | Any | Any |
strategy_targeting_segment_exclude_op | Any | Any |
strategy_targeting_segment_include_op | Any | Any |
strategy_type | Any | Any |
strategy_updated_on | Any | Any |
strategy_use_bid_shading | Any | Any |
strategy_use_campaign_end | Any | Any |
strategy_use_campaign_start | Any | Any |
strategy_use_dba_strategy_pacing | Any | Any |
strategy_use_dba_strategy_pacing_after_date | Any | Any |
strategy_use_mm_freq | Any | Any |
strategy_use_optimization | Any | Any |
strategy_version | Any | Any |
strategy_zone_name | Any | Any |
Metrics | ||
clicks | Any | Any |
ctc CTC | Any | Any |
ctr CTR | Any | Any |
general_invalid_clicks | Any | Any |
impressions | Any | Any |
post_click_conversions Post-Click Conversions | Any | Any |
post_view_conversions Post-View Conversions | Any | Any |
rr_per_1k_imps Response Rate/1K Imps | Any | Any |
total_clicks | Any | Any |
total_conversions | Any | Any |
total_spend | Any | Any |
total_spend_cpa Total Spend eCPA | Any | Any |
total_spend_cpc Total Spend eCPC | Any | Any |
total_spend_cpm Total Spend eCPM | Any | Any |
total_spend_pc_cpa Total Spend PC CPA | Any | Any |
total_spend_pv_cpa Total Spend PV CPA | Any | Any |
Pageable
No
Time Windows
current_day
, last_X_days
, month_to_date
, yesterday
Rollups
all
, by_day
, by_month
, by_week
Data Retention / Lookback Window
30 days
=
: Equals or contains ifvalue
is an array!=
: Not equals>
: Greater than>=
: Greater than or equals<
: Less than<=
: Less than or equals=~
: Text contains (case-insensitive)and
: All filters must matchor
: At least one filter must match
- Live Server
https://api.mediamath.com/reporting/v2/postal_code
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.mediamath.com/reporting/v2/postal_code \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"end_time": "2019-08-24T14:15:22Z",
"fields": [
"string"
],
"filters": [
{
"field": "string",
"filters": [
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
},
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
}
],
"op": "=",
"value": 0
}
],
"full_entities": [
"string"
],
"order": [
{
"desc": false,
"field": "string",
"nulls_last": false
}
],
"rollup": "string",
"start_time": "2019-08-24T14:15:22Z",
"time_window": "string",
"time_zone": "string"
}'
"{\"fields\":[{\"name\":\"agg_timestamp\"},{\"name\":\"campaign_id\"},{\"name\":\"impressions\"}],\"total_items_count\":14}\n{\"campaign_id\":102461,\"impressions\":93283,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}\n{\"campaign_id\":1228153,\"impressions\":484,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}\n{\"campaign_id\":1245119,\"impressions\":0,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}"
Request
Basic performance metrics as well as the "uniques" metric, broken out by frequency of ad exposure. Available in standard intervals.
Fields
Field | Time Windows | Rollups |
---|---|---|
Dimensions | ||
advertiser_id | Any | Any |
advertiser_name | Any | Any |
agency_id | Any | Any |
agency_name | Any | Any |
campaign_ads_txt_verified | Any | Any |
campaign_agency_fee_pct | Any | Any |
campaign_archived | Any | Any |
campaign_bid_min_devices | Any | Any |
campaign_brain_intraday_pacing | Any | Any |
campaign_connected_id_type | Any | Any |
campaign_conversion_type | Any | Any |
campaign_conversion_variable_minutes | Any | Any |
campaign_cost_passthrough_cpm_enabled | Any | Any |
campaign_cost_passthrough_cpm_value | Any | Any |
campaign_cost_passthrough_percent_enabled | Any | Any |
campaign_cost_passthrough_percent_value | Any | Any |
campaign_created_on Campaign Creation Time | Any | Any |
campaign_currency_code Campaign Currency Code | Any | Any |
campaign_custom_attribution_source | Any | Any |
campaign_dcs_data_is_campaign_level | Any | Any |
campaign_device_graph_only | Any | Any |
campaign_dynamic_budget_allocation_applied | Any | Any |
campaign_dynamic_budget_allocation_available | Any | Any |
campaign_dynamic_budget_allocation_type | Any | Any |
campaign_end_date (GMT) Campaign End Date | Any | Any |
campaign_end_date_tz (CTZ) Campaign End Date | Any | Any |
campaign_frequency_amount Campaign Frequency Amount | Any | Any |
campaign_frequency_interval Campaign Frequency Interval | Any | Any |
campaign_frequency_optimization Campaign Frequency Optimization | Any | Any |
campaign_frequency_type Campaign Frequency Type | Any | Any |
campaign_goal_alert | Any | Any |
campaign_goal_category | Any | Any |
campaign_goal_type | Any | Any |
campaign_goal_value | Any | Any |
campaign_has_custom_attribution | Any | Any |
campaign_id | Any | Any |
campaign_impression_cap_amount | Any | Any |
campaign_impression_cap_automatic | Any | Any |
campaign_impression_cap_type | Any | Any |
campaign_in_flight In Flight | Any | Any |
campaign_initial_start_date (GMT) Campaign Initial Start Date | Any | Any |
campaign_initial_start_date_tz (CTZ) Campaign Initial Start Date | Any | Any |
campaign_io_name | Any | Any |
campaign_io_reference_num | Any | Any |
campaign_is_programmatic_guaranteed Campaign Is Programmatic Guaranteed | Any | Any |
campaign_merit_pixel_id | Any | Any |
campaign_minimize_multi_ads Minimize Multi Ads | Any | Any |
campaign_name | Any | Any |
campaign_override_suspicious_traffic_filter | Any | Any |
campaign_pacing_alert | Any | Any |
campaign_pc_window_minutes | Any | Any |
campaign_political | Any | Any |
campaign_pv_pct | Any | Any |
campaign_pv_window_minutes | Any | Any |
campaign_restrict_targeting_to_deterministic_id | Any | Any |
campaign_restrict_targeting_to_same_device_id | Any | Any |
campaign_service_type Campaign Service Type, a.k.a. Managed Service Flag / managed_service_flag | Any | Any |
campaign_source_campaign_id | Any | Any |
campaign_spend_cap_amount | Any | Any |
campaign_spend_cap_automatic | Any | Any |
campaign_spend_cap_daily_cap | Any | Any |
campaign_spend_cap_type | Any | Any |
campaign_start_date (GMT) Campaign Start Date | Any | Any |
campaign_start_date_tz (CTZ) Campaign Start Date | Any | Any |
campaign_status Active Status | Any | Any |
campaign_suspicious_traffic_filter_level | Any | Any |
campaign_total_budget | Any | Any |
campaign_total_impression_budget Campaign Impressions Budget | Any | Any |
campaign_updated_on Campaign Update Time | Any | Any |
campaign_version | Any | Any |
campaign_zone_name Campaign Time Zone, a.k.a time_zone | Any | Any |
frequency number of impressions seen by a unique user | Any | Any |
frequency_bin | Any | Any |
organization_id | Any | Any |
organization_name | Any | Any |
strategy_ads_txt_verified | Any | Any |
strategy_archived | Any | Any |
strategy_audience_segment_exclude_op | Any | Any |
strategy_audience_segment_include_op | Any | Any |
strategy_bid_aggressiveness | Any | Any |
strategy_bid_min_devices | Any | Any |
strategy_bid_price_is_media_only | Any | Any |
strategy_budget | Any | Any |
strategy_cost_passthrough_cpm_enabled | Any | Any |
strategy_cost_passthrough_cpm_value | Any | Any |
strategy_cost_passthrough_percent_enabled | Any | Any |
strategy_cost_passthrough_percent_value | Any | Any |
strategy_created_on | Any | Any |
strategy_currency_code | Any | Any |
strategy_description | Any | Any |
strategy_device_graph_only | Any | Any |
strategy_end_date_raw | Any | Any |
strategy_exchange_type_for_run_on_all | Any | Any |
strategy_feature_compatibility | Any | Any |
strategy_frequency_amount | Any | Any |
strategy_frequency_interval Campaign Frequency Interval | Any | Any |
strategy_frequency_optimization | Any | Any |
strategy_frequency_type Campaign Frequency Type | Any | Any |
strategy_goal_type | Any | Any |
strategy_goal_value | Any | Any |
strategy_groups | Any | Any |
strategy_id | Any | Any |
strategy_impression_pacing_amount | Any | Any |
strategy_impression_pacing_interval | Any | Any |
strategy_impression_pacing_type | Any | Any |
strategy_max_bid | Any | Any |
strategy_max_bid_wm | Any | Any |
strategy_media_type | Any | Any |
strategy_min_bid | Any | Any |
strategy_name | Any | Any |
strategy_pacing_amount | Any | Any |
strategy_pacing_interval | Any | Any |
strategy_pacing_optimization_amount | Any | Any |
strategy_pacing_optimization_type | Any | Any |
strategy_pacing_type | Any | Any |
strategy_roi_target | Any | Any |
strategy_run_on_all_exchanges | Any | Any |
strategy_run_on_all_pmp | Any | Any |
strategy_run_on_display | Any | Any |
strategy_run_on_mobile | Any | Any |
strategy_run_on_only_fraud_filtered_exchanges | Any | Any |
strategy_run_on_streaming | Any | Any |
strategy_site_restriction_transparent_urls | Any | Any |
strategy_site_selectiveness | Any | Any |
strategy_source_only | Any | Any |
strategy_start_date_raw | Any | Any |
strategy_status Active Status | Any | Any |
strategy_supply_type | Any | Any |
strategy_targeting_segment_exclude_op | Any | Any |
strategy_targeting_segment_include_op | Any | Any |
strategy_type | Any | Any |
strategy_updated_on | Any | Any |
strategy_use_bid_shading | Any | Any |
strategy_use_campaign_end | Any | Any |
strategy_use_campaign_start | Any | Any |
strategy_use_dba_strategy_pacing | Any | Any |
strategy_use_dba_strategy_pacing_after_date | Any | Any |
strategy_use_mm_freq | Any | Any |
strategy_use_optimization | Any | Any |
strategy_version | Any | Any |
strategy_zone_name | Any | Any |
Metrics | ||
clicks | Any | Any |
ctc CTC | Any | Any |
ctr CTR | Any | Any |
general_invalid_clicks | Any | Any |
impressions | Any | Any |
post_click_conversions Post-Click Conversions | Any | Any |
post_view_conversions Post-View Conversions | Any | Any |
rr_per_1k_imps Response Rate/1K Imps | Any | Any |
total_clicks | Any | Any |
total_conversions | Any | Any |
uniques | Any | Any |
Pageable
Yes
Time Windows
last_14_days
, last_30_days
, last_7_days
, yesterday
Rollups
all
=
: Equals or contains ifvalue
is an array!=
: Not equals>
: Greater than>=
: Greater than or equals<
: Less than<=
: Less than or equals=~
: Text contains (case-insensitive)and
: All filters must matchor
: At least one filter must match
- Live Server
https://api.mediamath.com/reporting/v2/reach-frequency
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.mediamath.com/reporting/v2/reach-frequency \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"fields": [
"string"
],
"filters": [
{
"field": "string",
"filters": [
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
},
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
}
],
"op": "=",
"value": 0
}
],
"full_entities": [
"string"
],
"order": [
{
"desc": false,
"field": "string",
"nulls_last": false
}
],
"pagination": {
"page_index": 0,
"page_size": 1
},
"rollup": "string",
"time_window": "string",
"time_zone": "string"
}'
{ "meta": { "items_count": 0, "page_index": 0, "status": "ok", "total_items_count": 0, "total_pages": 0 }, "results": [ {} ] }
Request
Metrics describe the auction before a win or even a bid has taken place. Broken out by strategy, exchange, and deal dimensions and available by hour.
Fields
Field | Time Windows | Rollups |
---|---|---|
Dimensions | ||
agg_timestamp | current_day , last_X_days , last_X_hours , month_to_date , yesterday | by_day , by_hour , by_month , by_week |
advertiser_id | Any | Any |
advertiser_name | Any | Any |
agency_id | Any | Any |
agency_name | Any | Any |
attribution_group | Any | Any |
campaign_ads_txt_verified | Any | Any |
campaign_agency_fee_pct | Any | Any |
campaign_archived | Any | Any |
campaign_bid_min_devices | Any | Any |
campaign_brain_intraday_pacing | Any | Any |
campaign_connected_id_type | Any | Any |
campaign_conversion_type | Any | Any |
campaign_conversion_variable_minutes | Any | Any |
campaign_cost_passthrough_cpm_enabled | Any | Any |
campaign_cost_passthrough_cpm_value | Any | Any |
campaign_cost_passthrough_percent_enabled | Any | Any |
campaign_cost_passthrough_percent_value | Any | Any |
campaign_created_on Campaign Creation Time | Any | Any |
campaign_currency_code Campaign Currency Code | Any | Any |
campaign_custom_attribution_source | Any | Any |
campaign_dcs_data_is_campaign_level | Any | Any |
campaign_device_graph_only | Any | Any |
campaign_dynamic_budget_allocation_applied | Any | Any |
campaign_dynamic_budget_allocation_available | Any | Any |
campaign_dynamic_budget_allocation_type | Any | Any |
campaign_end_date (GMT) Campaign End Date | Any | Any |
campaign_end_date_tz (CTZ) Campaign End Date | Any | Any |
campaign_frequency_amount Campaign Frequency Amount | Any | Any |
campaign_frequency_interval Campaign Frequency Interval | Any | Any |
campaign_frequency_optimization Campaign Frequency Optimization | Any | Any |
campaign_frequency_type Campaign Frequency Type | Any | Any |
campaign_goal_alert | Any | Any |
campaign_goal_category | Any | Any |
campaign_goal_type | Any | Any |
campaign_goal_value | Any | Any |
campaign_has_custom_attribution | Any | Any |
campaign_id | Any | Any |
campaign_impression_cap_amount | Any | Any |
campaign_impression_cap_automatic | Any | Any |
campaign_impression_cap_type | Any | Any |
campaign_in_flight In Flight | Any | Any |
campaign_initial_start_date (GMT) Campaign Initial Start Date | Any | Any |
campaign_initial_start_date_tz (CTZ) Campaign Initial Start Date | Any | Any |
campaign_io_name | Any | Any |
campaign_io_reference_num | Any | Any |
campaign_is_programmatic_guaranteed Campaign Is Programmatic Guaranteed | Any | Any |
campaign_merit_pixel_id | Any | Any |
campaign_minimize_multi_ads Minimize Multi Ads | Any | Any |
campaign_name | Any | Any |
campaign_override_suspicious_traffic_filter | Any | Any |
campaign_pacing_alert | Any | Any |
campaign_pc_window_minutes | Any | Any |
campaign_political | Any | Any |
campaign_pv_pct | Any | Any |
campaign_pv_window_minutes | Any | Any |
campaign_restrict_targeting_to_deterministic_id | Any | Any |
campaign_restrict_targeting_to_same_device_id | Any | Any |
campaign_service_type Campaign Service Type, a.k.a. Managed Service Flag / managed_service_flag | Any | Any |
campaign_source_campaign_id | Any | Any |
campaign_spend_cap_amount | Any | Any |
campaign_spend_cap_automatic | Any | Any |
campaign_spend_cap_daily_cap | Any | Any |
campaign_spend_cap_type | Any | Any |
campaign_start_date (GMT) Campaign Start Date | Any | Any |
campaign_start_date_tz (CTZ) Campaign Start Date | Any | Any |
campaign_status Active Status | Any | Any |
campaign_suspicious_traffic_filter_level | Any | Any |
campaign_total_budget | Any | Any |
campaign_total_impression_budget Campaign Impressions Budget | Any | Any |
campaign_updated_on Campaign Update Time | Any | Any |
campaign_version | Any | Any |
campaign_zone_name Campaign Time Zone, a.k.a time_zone | Any | Any |
deal_exchange_id | Any | Any |
deal_external_id | Any | Any |
deal_group_id | Any | Any |
deal_group_name | Any | Any |
deal_id | Any | Any |
deal_name | Any | Any |
deal_organization_id | Any | Any |
deal_price_type | Any | Any |
deal_publisher_id Deal Publisher ID | Any | Any |
exchange_id | Any | Any |
exchange_name | Any | Any |
organization_id | Any | Any |
organization_name | Any | Any |
strategy_ads_txt_verified | Any | Any |
strategy_archived | Any | Any |
strategy_audience_segment_exclude_op | Any | Any |
strategy_audience_segment_include_op | Any | Any |
strategy_bid_aggressiveness | Any | Any |
strategy_bid_min_devices | Any | Any |
strategy_bid_price_is_media_only | Any | Any |
strategy_budget | Any | Any |
strategy_cost_passthrough_cpm_enabled | Any | Any |
strategy_cost_passthrough_cpm_value | Any | Any |
strategy_cost_passthrough_percent_enabled | Any | Any |
strategy_cost_passthrough_percent_value | Any | Any |
strategy_created_on | Any | Any |
strategy_currency_code | Any | Any |
strategy_description | Any | Any |
strategy_device_graph_only | Any | Any |
strategy_end_date_raw | Any | Any |
strategy_exchange_type_for_run_on_all | Any | Any |
strategy_feature_compatibility | Any | Any |
strategy_frequency_amount | Any | Any |
strategy_frequency_interval Campaign Frequency Interval | Any | Any |
strategy_frequency_optimization | Any | Any |
strategy_frequency_type Campaign Frequency Type | Any | Any |
strategy_goal_type | Any | Any |
strategy_goal_value | Any | Any |
strategy_groups | Any | Any |
strategy_id | Any | Any |
strategy_impression_pacing_amount | Any | Any |
strategy_impression_pacing_interval | Any | Any |
strategy_impression_pacing_type | Any | Any |
strategy_max_bid | Any | Any |
strategy_max_bid_wm | Any | Any |
strategy_media_type | Any | Any |
strategy_min_bid | Any | Any |
strategy_name | Any | Any |
strategy_pacing_amount | Any | Any |
strategy_pacing_interval | Any | Any |
strategy_pacing_optimization_amount | Any | Any |
strategy_pacing_optimization_type | Any | Any |
strategy_pacing_type | Any | Any |
strategy_roi_target | Any | Any |
strategy_run_on_all_exchanges | Any | Any |
strategy_run_on_all_pmp | Any | Any |
strategy_run_on_display | Any | Any |
strategy_run_on_mobile | Any | Any |
strategy_run_on_only_fraud_filtered_exchanges | Any | Any |
strategy_run_on_streaming | Any | Any |
strategy_site_restriction_transparent_urls | Any | Any |
strategy_site_selectiveness | Any | Any |
strategy_source_only | Any | Any |
strategy_start_date_raw | Any | Any |
strategy_status Active Status | Any | Any |
strategy_supply_type | Any | Any |
strategy_targeting_segment_exclude_op | Any | Any |
strategy_targeting_segment_include_op | Any | Any |
strategy_type | Any | Any |
strategy_updated_on | Any | Any |
strategy_use_bid_shading | Any | Any |
strategy_use_campaign_end | Any | Any |
strategy_use_campaign_start | Any | Any |
strategy_use_dba_strategy_pacing | Any | Any |
strategy_use_dba_strategy_pacing_after_date | Any | Any |
strategy_use_mm_freq | Any | Any |
strategy_use_optimization | Any | Any |
strategy_version | Any | Any |
strategy_zone_name | Any | Any |
Metrics | ||
average_bid_amount_cpm | Any | Any |
average_win_amount_cpm | Any | Any |
bid_rate | Any | Any |
bids | Any | Any |
matched_bid_opportunities | Any | Any |
max_bid_amount_cpm | Any | Any |
max_win_amount_cpm | Any | Any |
min_bid_amount_cpm | Any | Any |
min_win_amount_cpm | Any | Any |
pacing_matched_bid_opportunities | Any | Any |
total_bid_amount_cpm | Any | Any |
total_win_amount_cpm | Any | Any |
win_rate | Any | Any |
wins | Any | Any |
Pageable
No
Time Windows
current_day
, last_X_days
, last_X_hours
, month_to_date
, yesterday
Rollups
all
, by_day
, by_hour
, by_month
, by_week
Data Retention / Lookback Window
1 year
=
: Equals or contains ifvalue
is an array!=
: Not equals>
: Greater than>=
: Greater than or equals<
: Less than<=
: Less than or equals=~
: Text contains (case-insensitive)and
: All filters must matchor
: At least one filter must match
- Live Server
https://api.mediamath.com/reporting/v2/win-loss
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.mediamath.com/reporting/v2/win-loss \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"end_time": "2019-08-24T14:15:22Z",
"fields": [
"string"
],
"filters": [
{
"field": "string",
"filters": [
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
},
{
"field": "string",
"filters": [
{}
],
"op": "=",
"value": 0
}
],
"op": "=",
"value": 0
}
],
"full_entities": [
"string"
],
"order": [
{
"desc": false,
"field": "string",
"nulls_last": false
}
],
"rollup": "string",
"start_time": "2019-08-24T14:15:22Z",
"time_window": "string",
"time_zone": "string"
}'
"{\"fields\":[{\"name\":\"agg_timestamp\"},{\"name\":\"campaign_id\"},{\"name\":\"impressions\"}],\"total_items_count\":14}\n{\"campaign_id\":102461,\"impressions\":93283,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}\n{\"campaign_id\":1228153,\"impressions\":484,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}\n{\"campaign_id\":1245119,\"impressions\":0,\"agg_timestamp\":\"2023-03-01T15:00:00Z\"}"