Reporting API V2 (1.0.0)

OpenAPI 3.0 spec of the Reporting API.

Documentation WIP

We are actively working on improving these docs. Please reach out if you have any feedback or suggestions.

Beta datasets

Datasets marked as (beta) are subject to change or removal without prior notice, and are offered as is with no support.

Download OpenAPI description
Languages
Servers
Mock server
https://apidocs.mediamath.com/_mock/apis/reporting-api/openapi/
Live Server
https://api.mediamath.com/reporting/v2/

Common

Datasets

Operations

All Dimensions and Metrics Report

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

FieldTime WindowsRollups
Dimensions
agg_timestampcurrent_day, last_X_days, month_to_date, yesterdayby_day, by_month, by_week
ads_txt_type
Ads.txt Type
AnyAny
ads_txt_verified
Ads.txt Verified
AnyAny
advertiser_id
AnyAny
advertiser_name
AnyAny
agency_id
AnyAny
agency_name
AnyAny
app_id
AnyAny
app_name
AnyAny
attribution_group
AnyAny
auction_type
AnyAny
bid_price_impact
AnyAny
browser
AnyAny
browser_version
AnyAny
campaign_ads_txt_verified
AnyAny
campaign_agency_fee_pct
AnyAny
campaign_archived
AnyAny
campaign_bid_min_devices
AnyAny
campaign_brain_intraday_pacing
AnyAny
campaign_connected_id_type
AnyAny
campaign_conversion_type
AnyAny
campaign_conversion_variable_minutes
AnyAny
campaign_cost_passthrough_cpm_enabled
AnyAny
campaign_cost_passthrough_cpm_value
AnyAny
campaign_cost_passthrough_percent_enabled
AnyAny
campaign_cost_passthrough_percent_value
AnyAny
campaign_created_on
Campaign Creation Time
AnyAny
campaign_currency_code
Campaign Currency Code
AnyAny
campaign_custom_attribution_source
AnyAny
campaign_dcs_data_is_campaign_level
AnyAny
campaign_device_graph_only
AnyAny
campaign_dynamic_budget_allocation_applied
AnyAny
campaign_dynamic_budget_allocation_available
AnyAny
campaign_dynamic_budget_allocation_type
AnyAny
campaign_end_date
(GMT) Campaign End Date
AnyAny
campaign_end_date_tz
(CTZ) Campaign End Date
AnyAny
campaign_frequency_amount
Campaign Frequency Amount
AnyAny
campaign_frequency_interval
Campaign Frequency Interval
AnyAny
campaign_frequency_optimization
Campaign Frequency Optimization
AnyAny
campaign_frequency_type
Campaign Frequency Type
AnyAny
campaign_goal_alert
AnyAny
campaign_goal_category
AnyAny
campaign_goal_type
AnyAny
campaign_goal_value
AnyAny
campaign_has_custom_attribution
AnyAny
campaign_id
AnyAny
campaign_impression_cap_amount
AnyAny
campaign_impression_cap_automatic
AnyAny
campaign_impression_cap_type
AnyAny
campaign_in_flight
In Flight
AnyAny
campaign_initial_start_date
(GMT) Campaign Initial Start Date
AnyAny
campaign_initial_start_date_tz
(CTZ) Campaign Initial Start Date
AnyAny
campaign_io_name
AnyAny
campaign_io_reference_num
AnyAny
campaign_is_programmatic_guaranteed
Campaign Is Programmatic Guaranteed
AnyAny
campaign_merit_pixel_id
AnyAny
campaign_minimize_multi_ads
Minimize Multi Ads
AnyAny
campaign_name
AnyAny
campaign_override_suspicious_traffic_filter
AnyAny
campaign_pacing_alert
AnyAny
campaign_pc_window_minutes
AnyAny
campaign_political
AnyAny
campaign_pv_pct
AnyAny
campaign_pv_window_minutes
AnyAny
campaign_restrict_targeting_to_deterministic_id
AnyAny
campaign_restrict_targeting_to_same_device_id
AnyAny
campaign_service_type
Campaign Service Type, a.k.a. Managed Service Flag / managed_service_flag
AnyAny
campaign_source_campaign_id
AnyAny
campaign_spend_cap_amount
AnyAny
campaign_spend_cap_automatic
AnyAny
campaign_spend_cap_daily_cap
AnyAny
campaign_spend_cap_type
AnyAny
campaign_start_date
(GMT) Campaign Start Date
AnyAny
campaign_start_date_tz
(CTZ) Campaign Start Date
AnyAny
campaign_status
Active Status
AnyAny
campaign_suspicious_traffic_filter_level
AnyAny
campaign_total_budget
AnyAny
campaign_total_impression_budget
Campaign Impressions Budget
AnyAny
campaign_updated_on
Campaign Update Time
AnyAny
campaign_version
AnyAny
campaign_zone_name
Campaign Time Zone, a.k.a time_zone
AnyAny
channel_type
AnyAny
city_code
AnyAny
city_name
AnyAny
concept_id
AnyAny
concept_name
AnyAny
conn_speed
Connection Speed
AnyAny
conn_speed_name
AnyAny
content_title
AnyAny
country
AnyAny
country_name
AnyAny
creative_file_type
AnyAny
creative_has_sound
AnyAny
creative_id
AnyAny
creative_is_native
AnyAny
creative_name
AnyAny
creative_rich_media
AnyAny
creative_size
AnyAny
creative_tpas_placement_id
AnyAny
creative_tpas_placement_name
AnyAny
currency_rate_date
AnyAny
currency_rate_rate
AnyAny
deal_exchange_id
AnyAny
deal_external_id
AnyAny
deal_group_id
AnyAny
deal_group_name
AnyAny
deal_id
AnyAny
deal_name
AnyAny
deal_organization_id
AnyAny
deal_price_type
AnyAny
deal_publisher_id
Deal Publisher ID
AnyAny
device_make
AnyAny
device_model
AnyAny
exchange_id
AnyAny
exchange_name
AnyAny
flight_id
AnyAny
form_factor
Device Type
AnyAny
inventory_browser_type
AnyAny
inventory_market_type
AnyAny
isp
AnyAny
isp_name
AnyAny
margin_date
AnyAny
margin_pct
AnyAny
metro_code
AnyAny
metro_name
AnyAny
mm_buying_modality
Buying Modality
AnyAny
openrtb_device_type
OpenRTB Device Type
AnyAny
organization_id
AnyAny
organization_name
AnyAny
os_type
OS Type
AnyAny
os_version
OS Version
AnyAny
postal_code_name
AnyAny
prisma_campaign_id
AnyAny
prisma_client_product_estimate
AnyAny
prisma_io_number
AnyAny
publisher_description
AnyAny
publisher_id
AnyAny
region
AnyAny
region_name
AnyAny
site_domain
AnyAny
strategy_ads_txt_verified
AnyAny
strategy_archived
AnyAny
strategy_audience_segment_exclude_op
AnyAny
strategy_audience_segment_include_op
AnyAny
strategy_bid_aggressiveness
AnyAny
strategy_bid_min_devices
AnyAny
strategy_bid_price_is_media_only
AnyAny
strategy_budget
AnyAny
strategy_cost_passthrough_cpm_enabled
AnyAny
strategy_cost_passthrough_cpm_value
AnyAny
strategy_cost_passthrough_percent_enabled
AnyAny
strategy_cost_passthrough_percent_value
AnyAny
strategy_created_on
AnyAny
strategy_currency_code
AnyAny
strategy_description
AnyAny
strategy_device_graph_only
AnyAny
strategy_end_date_raw
AnyAny
strategy_exchange_type_for_run_on_all
AnyAny
strategy_feature_compatibility
AnyAny
strategy_frequency_amount
AnyAny
strategy_frequency_interval
Campaign Frequency Interval
AnyAny
strategy_frequency_optimization
AnyAny
strategy_frequency_type
Campaign Frequency Type
AnyAny
strategy_goal_type
AnyAny
strategy_goal_value
AnyAny
strategy_groups
AnyAny
strategy_id
AnyAny
strategy_impression_pacing_amount
AnyAny
strategy_impression_pacing_interval
AnyAny
strategy_impression_pacing_type
AnyAny
strategy_max_bid
AnyAny
strategy_max_bid_wm
AnyAny
strategy_media_type
AnyAny
strategy_min_bid
AnyAny
strategy_name
AnyAny
strategy_pacing_amount
AnyAny
strategy_pacing_interval
AnyAny
strategy_pacing_optimization_amount
AnyAny
strategy_pacing_optimization_type
AnyAny
strategy_pacing_type
AnyAny
strategy_roi_target
AnyAny
strategy_run_on_all_exchanges
AnyAny
strategy_run_on_all_pmp
AnyAny
strategy_run_on_display
AnyAny
strategy_run_on_mobile
AnyAny
strategy_run_on_only_fraud_filtered_exchanges
AnyAny
strategy_run_on_streaming
AnyAny
strategy_site_restriction_transparent_urls
AnyAny
strategy_site_selectiveness
AnyAny
strategy_source_only
AnyAny
strategy_start_date_raw
AnyAny
strategy_status
Active Status
AnyAny
strategy_supply_type
AnyAny
strategy_targeting_segment_exclude_op
AnyAny
strategy_targeting_segment_include_op
AnyAny
strategy_type
AnyAny
strategy_updated_on
AnyAny
strategy_use_bid_shading
AnyAny
strategy_use_campaign_end
AnyAny
strategy_use_campaign_start
AnyAny
strategy_use_dba_strategy_pacing
AnyAny
strategy_use_dba_strategy_pacing_after_date
AnyAny
strategy_use_mm_freq
AnyAny
strategy_use_optimization
AnyAny
strategy_version
AnyAny
strategy_zone_name
AnyAny
video_placement
AnyAny
video_skippability
AnyAny
zip
AnyAny
Metrics
accept_invitation_count
AnyAny
calculated_impressions
AnyAny
clicks
AnyAny
ctc
CTC
AnyAny
ctr
CTR
AnyAny
general_invalid_clicks
AnyAny
impressions
AnyAny
in_view
In View Impressions
AnyAny
in_view_100_percent
100% In View Impressions
AnyAny
in_view_15_seconds
In View - 15 Seconds
AnyAny
in_view_15_seconds_rate
In View 15 Seconds Rate
AnyAny
in_view_5_seconds
In View - 5 Seconds
AnyAny
in_view_5_seconds_rate
In View 5 Seconds Rate
AnyAny
in_view_q1
AnyAny
in_view_q2
AnyAny
in_view_q3
AnyAny
in_view_q4
AnyAny
measurability_rate
Measurability Rate
AnyAny
measurable
Measurable Impressions
AnyAny
media_cost
AnyAny
media_cost_usd
(USD) Media Cost
AnyAny
non_watermark_impressions
Non-Watermark Impressions
AnyAny
non_watermark_spend_usd
Non-Watermark Spend (USD)
AnyAny
post_click_aov
Post-Click AOV
AnyAny
post_click_aov_usd
(USD) Post-Click AOV
AnyAny
post_click_conversions
Post-Click Conversions
AnyAny
post_click_revenue
Post-Click Revenue
AnyAny
post_click_revenue_usd
(USD) Post-Click Revenue
AnyAny
post_click_total_spend_roi
Post-Click Total Spend ROI
AnyAny
post_view_aov
Post-View AOV
AnyAny
post_view_aov_usd
(USD) Post-View AOV
AnyAny
post_view_conversions
Post-View Conversions
AnyAny
post_view_revenue
Post-View Revenue
AnyAny
post_view_revenue_usd
(USD) Post-View Revenue
AnyAny
post_view_total_spend_roi
Post-View Total Spend ROI
AnyAny
rr_per_1k_imps
Response Rate/1K Imps
AnyAny
third_party_events
3PA Events
AnyAny
third_party_revenue
3PA Total Revenue
AnyAny
third_party_revenue_usd
(USD) 3PA Total Revenue
AnyAny
total_aov
Total AOV
AnyAny
total_aov_usd
(USD) Total AOV
AnyAny
total_clicks
AnyAny
total_conversions
AnyAny
total_revenue
AnyAny
total_revenue_usd
(USD) Total Revenue
AnyAny
total_spend
AnyAny
total_spend_cpa
Total Spend eCPA
AnyAny
total_spend_cpa_usd
(USD) Total Spend eCPA
AnyAny
total_spend_cpc
Total Spend eCPC
AnyAny
total_spend_cpc_usd
(USD) Total Spend eCPC
AnyAny
total_spend_cpcv
Total Spend eCPCV
AnyAny
total_spend_cpcv_usd
(USD) Total Spend eCPCV
AnyAny
total_spend_cpm
Total Spend eCPM
AnyAny
total_spend_cpm_usd
(USD) Total Spend eCPM
AnyAny
total_spend_pc_cpa
Total Spend PC CPA
AnyAny
total_spend_pc_cpa_usd
(USD) Total Spend PC CPA
AnyAny
total_spend_pv_cpa
Total Spend PV CPA
AnyAny
total_spend_pv_cpa_usd
(USD) Total Spend PV CPA
AnyAny
total_spend_roi
Total Spend ROI
AnyAny
total_spend_usd
(USD) Total Spend
AnyAny
total_spend_vcpm
Total Spend vCPM
AnyAny
total_spend_vcpm_usd
(USD) Total Spend vCPM
AnyAny
video_close
Close
AnyAny
video_collapse
Collapse
AnyAny
video_companion_clicks
Companion Clicks
AnyAny
video_companion_ctr
Companion CTR
AnyAny
video_companion_impressions
Companion Impressions
AnyAny
video_complete
100% Completed Views
AnyAny
video_complete_rate
100% Completed Rate
AnyAny
video_complete_rate_impression_based
100% Completed Rate - Impressions Based
AnyAny
video_engaged_impressions
Engaged Impressions
AnyAny
video_engaged_rate
Engaged Rate
AnyAny
video_expand
Expand
AnyAny
video_first_quartile
25% Completed Views
AnyAny
video_first_quartile_rate
25% Completed Rate
AnyAny
video_first_quartile_rate_impression_based
25% Completed Rate - Impressions Based
AnyAny
video_fullscreen
Fullscreen
AnyAny
video_midpoint
50% Completed Views
AnyAny
video_midpoint_rate
50% Completed Rate
AnyAny
video_midpoint_rate_impression_based
50% Completed Rate - Impressions Based
AnyAny
video_mute
Mute
AnyAny
video_pause
Pause
AnyAny
video_play_rate
Play Rate
AnyAny
video_resume
Resume
AnyAny
video_rewind
Rewind
AnyAny
video_skip
Skip
AnyAny
video_skippable_impressions
Skippable Impressions
AnyAny
video_skipped_impressions
Skipped Impressions
AnyAny
video_skipped_rate
Skipped Rate
AnyAny
video_start
Start
AnyAny
video_third_quartile
75% Completed Views
AnyAny
video_third_quartile_rate
75% Completed Rate
AnyAny
video_third_quartile_rate_impression_based
75% Completed Rate - Impressions Based
AnyAny
video_unmute
Unmute
AnyAny
viewability_rate
Viewability Rate
AnyAny
viewability_rate_100_percent
100% In View Rate
AnyAny
watermark_impressions
AnyAny
watermark_spend_pct
Watermark Spend Percent
AnyAny
watermark_spend_usd
Watermark Spend (USD)
AnyAny

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

Bodyapplication/jsonrequired
One of:
end_timestring or null(date-time)
fieldsArray of stringsnon-emptyuniquerequired
filtersArray of objectsnon-emptyrequired
filters[].​fieldstring
filters[].​filtersArray of objects or null>= 2 items
filters[].​opstring
  • =: Equals or contains if value 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 match
  • or: At least one filter must match
Default "="
filters[].​value(integer or number or string or boolean) or boolean or (Array of integers or numbers or strings or booleans)
One of:
One of:
integer
full_entitiesArray of strings or nullnon-emptyunique
orderArray of objectsnon-emptyrequired
order[].​descboolean
Default false
order[].​fieldstringrequired
order[].​nulls_lastboolean
Default false
rollupstringrequired
start_timestring(date-time)
time_windowstringrequired
time_zonestring

Only in supported datasets: campaign, UTC or a time zone name defined in https://www.iana.org/time-zones

curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/reporting-api/openapi/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"
  }'

Responses

JSON for Paginated, JSONL for Streaming

Bodyapplication/jsonl
string(Streaming Response)

Documentation available at https://apidocs.mediamath.com/docs/reporting-api-v2

Response
application/jsonl
"{\"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\"}"

Audience Index

Request

Special index metrics for comparing your site visitors to 3rd party segments. Broken out by audience name and pixel.

Fields

FieldTime WindowsRollups
Dimensions
advertiser_id
AnyAny
advertiser_name
AnyAny
agency_id
AnyAny
agency_name
AnyAny
audience_id
AnyAny
audience_name
AnyAny
audience_path
AnyAny
campaign_ads_txt_verified
AnyAny
campaign_agency_fee_pct
AnyAny
campaign_archived
AnyAny
campaign_bid_min_devices
AnyAny
campaign_brain_intraday_pacing
AnyAny
campaign_connected_id_type
AnyAny
campaign_conversion_type
AnyAny
campaign_conversion_variable_minutes
AnyAny
campaign_cost_passthrough_cpm_enabled
AnyAny
campaign_cost_passthrough_cpm_value
AnyAny
campaign_cost_passthrough_percent_enabled
AnyAny
campaign_cost_passthrough_percent_value
AnyAny
campaign_created_on
Campaign Creation Time
AnyAny
campaign_currency_code
Campaign Currency Code
AnyAny
campaign_custom_attribution_source
AnyAny
campaign_dcs_data_is_campaign_level
AnyAny
campaign_device_graph_only
AnyAny
campaign_dynamic_budget_allocation_applied
AnyAny
campaign_dynamic_budget_allocation_available
AnyAny
campaign_dynamic_budget_allocation_type
AnyAny
campaign_end_date
(GMT) Campaign End Date
AnyAny
campaign_end_date_tz
(CTZ) Campaign End Date
AnyAny
campaign_frequency_amount
Campaign Frequency Amount
AnyAny
campaign_frequency_interval
Campaign Frequency Interval
AnyAny
campaign_frequency_optimization
Campaign Frequency Optimization
AnyAny
campaign_frequency_type
Campaign Frequency Type
AnyAny
campaign_goal_alert
AnyAny
campaign_goal_category
AnyAny
campaign_goal_type
AnyAny
campaign_goal_value
AnyAny
campaign_has_custom_attribution
AnyAny
campaign_id
AnyAny
campaign_impression_cap_amount
AnyAny
campaign_impression_cap_automatic
AnyAny
campaign_impression_cap_type
AnyAny
campaign_in_flight
In Flight
AnyAny
campaign_initial_start_date
(GMT) Campaign Initial Start Date
AnyAny
campaign_initial_start_date_tz
(CTZ) Campaign Initial Start Date
AnyAny
campaign_io_name
AnyAny
campaign_io_reference_num
AnyAny
campaign_is_programmatic_guaranteed
Campaign Is Programmatic Guaranteed
AnyAny
campaign_merit_pixel_id
AnyAny
campaign_minimize_multi_ads
Minimize Multi Ads
AnyAny
campaign_name
AnyAny
campaign_override_suspicious_traffic_filter
AnyAny
campaign_pacing_alert
AnyAny
campaign_pc_window_minutes
AnyAny
campaign_political
AnyAny
campaign_pv_pct
AnyAny
campaign_pv_window_minutes
AnyAny
campaign_restrict_targeting_to_deterministic_id
AnyAny
campaign_restrict_targeting_to_same_device_id
AnyAny
campaign_service_type
Campaign Service Type, a.k.a. Managed Service Flag / managed_service_flag
AnyAny
campaign_source_campaign_id
AnyAny
campaign_spend_cap_amount
AnyAny
campaign_spend_cap_automatic
AnyAny
campaign_spend_cap_daily_cap
AnyAny
campaign_spend_cap_type
AnyAny
campaign_start_date
(GMT) Campaign Start Date
AnyAny
campaign_start_date_tz
(CTZ) Campaign Start Date
AnyAny
campaign_status
Active Status
AnyAny
campaign_suspicious_traffic_filter_level
AnyAny
campaign_total_budget
AnyAny
campaign_total_impression_budget
Campaign Impressions Budget
AnyAny
campaign_updated_on
Campaign Update Time
AnyAny
campaign_version
AnyAny
campaign_zone_name
Campaign Time Zone, a.k.a time_zone
AnyAny
organization_id
AnyAny
organization_name
AnyAny
Metrics
audience_index
Measure of users exposed to your site/media against general internet population
AnyAny
matched_impressions
AnyAny

Pageable

Yes

Time Windows

last_14_days

Rollups

all

Bodyapplication/jsonrequired
fieldsArray of stringsnon-emptyuniquerequired
filtersArray of objectsnon-emptyrequired
filters[].​fieldstring
filters[].​filtersArray of objects or null>= 2 items
filters[].​opstring
  • =: Equals or contains if value 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 match
  • or: At least one filter must match
Default "="
filters[].​value(integer or number or string or boolean) or boolean or (Array of integers or numbers or strings or booleans)
One of:
One of:
integer
full_entitiesArray of strings or nullnon-emptyunique
orderArray of objectsnon-emptyrequired
order[].​descboolean
Default false
order[].​fieldstringrequired
order[].​nulls_lastboolean
Default false
paginationobject or null

Streaming response if absent or null, Paginated response otherwise

rollupstringrequired
time_windowstringrequired
time_zonestring

Only in supported datasets: campaign, UTC or a time zone name defined in https://www.iana.org/time-zones

curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/reporting-api/openapi/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"
  }'

Responses

JSON for Paginated, JSONL for Streaming

Body
metaobject
resultsArray of objects
Response
{ "meta": { "items_count": 0, "page_index": 0, "status": "ok", "total_items_count": 0, "total_pages": 0 }, "results": [ {} ] }

Audience Index Pixel

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

FieldTime WindowsRollups
Dimensions
advertiser_id
AnyAny
advertiser_name
AnyAny
agency_id
AnyAny
agency_name
AnyAny
audience_id
AnyAny
audience_name
AnyAny
audience_path
AnyAny
organization_id
AnyAny
organization_name
AnyAny
pixel_advertiser_id
AnyAny
pixel_created_on
Pixel Creation Time
AnyAny
pixel_external_identifier
AnyAny
pixel_id
AnyAny
pixel_name
AnyAny
pixel_provider_created_on
AnyAny
pixel_provider_id
AnyAny
pixel_provider_name
AnyAny
pixel_provider_updated_on
AnyAny
pixel_status
AnyAny
pixel_tag_type
AnyAny
pixel_type
AnyAny
pixel_updated_on
Pixel Update Time
AnyAny
Metrics
audience_index
Measure of users exposed to your site/media against general internet population
AnyAny
matched_users
AnyAny

Pageable

Yes

Time Windows

last_14_days

Rollups

all

Bodyapplication/jsonrequired
fieldsArray of stringsnon-emptyuniquerequired
filtersArray of objectsnon-emptyrequired
filters[].​fieldstring
filters[].​filtersArray of objects or null>= 2 items
filters[].​opstring
  • =: Equals or contains if value 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 match
  • or: At least one filter must match
Default "="
filters[].​value(integer or number or string or boolean) or boolean or (Array of integers or numbers or strings or booleans)
One of:
One of:
integer
full_entitiesArray of strings or nullnon-emptyunique
orderArray of objectsnon-emptyrequired
order[].​descboolean
Default false
order[].​fieldstringrequired
order[].​nulls_lastboolean
Default false
paginationobject or null

Streaming response if absent or null, Paginated response otherwise

rollupstringrequired
time_windowstringrequired
time_zonestring

Only in supported datasets: campaign, UTC or a time zone name defined in https://www.iana.org/time-zones

curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/reporting-api/openapi/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"
  }'

Responses

JSON for Paginated, JSONL for Streaming

Body
metaobject
resultsArray of objects
Response
{ "meta": { "items_count": 0, "page_index": 0, "status": "ok", "total_items_count": 0, "total_pages": 0 }, "results": [ {} ] }

Brain Feature Summary Report

Request

Brain Feature Summary Report

Fields

FieldTime WindowsRollups
Dimensions
advertiser_id
AnyAny
advertiser_name
AnyAny
agency_id
AnyAny
agency_name
AnyAny
campaign_id
AnyAny
campaign_name
AnyAny
feature
AnyAny
index
AnyAny
model_goal
AnyAny
organization_id
AnyAny
organization_name
AnyAny
position
AnyAny
Metrics

Pageable

Yes

Time Windows

last_X_days, month_to_date, yesterday

Rollups

by_day

Bodyapplication/jsonrequired
One of:
end_timestring or null(date-time)
fieldsArray of stringsnon-emptyuniquerequired
filtersArray of objectsnon-emptyrequired
filters[].​fieldstring
filters[].​filtersArray of objects or null>= 2 items
filters[].​opstring
  • =: Equals or contains if value 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 match
  • or: At least one filter must match
Default "="
filters[].​value(integer or number or string or boolean) or boolean or (Array of integers or numbers or strings or booleans)
One of:
One of:
integer
full_entitiesArray of strings or nullnon-emptyunique
orderArray of objectsnon-emptyrequired
order[].​descboolean
Default false
order[].​fieldstringrequired
order[].​nulls_lastboolean
Default false
paginationobject or null

Streaming response if absent or null, Paginated response otherwise

rollupstringrequired
start_timestring(date-time)
time_windowstringrequired
time_zonestring

Only in supported datasets: campaign, UTC or a time zone name defined in https://www.iana.org/time-zones

curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/reporting-api/openapi/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"
  }'

Responses

JSON for Paginated, JSONL for Streaming

Body
metaobject
resultsArray of objects
Response
{ "meta": { "items_count": 0, "page_index": 0, "status": "ok", "total_items_count": 0, "total_pages": 0 }, "results": [ {} ] }

Brain Feature Value Report

Request

Brain Feature Value Report

Fields

FieldTime WindowsRollups
Dimensions
advertiser_id
AnyAny
advertiser_name
AnyAny
agency_id
AnyAny
agency_name
AnyAny
bid_impact
AnyAny
campaign_id
AnyAny
campaign_name
AnyAny
feature
AnyAny
feature_report_type
AnyAny
feature_value
AnyAny
index
AnyAny
is_numeric
AnyAny
mean
AnyAny
model_goal
AnyAny
organization_id
AnyAny
organization_name
AnyAny
position
AnyAny
Metrics

Pageable

Yes

Time Windows

last_X_days, month_to_date, yesterday

Rollups

by_day

Bodyapplication/jsonrequired
One of:
end_timestring or null(date-time)
fieldsArray of stringsnon-emptyuniquerequired
filtersArray of objectsnon-emptyrequired
filters[].​fieldstring
filters[].​filtersArray of objects or null>= 2 items
filters[].​opstring
  • =: Equals or contains if value 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 match
  • or: At least one filter must match
Default "="
filters[].​value(integer or number or string or boolean) or boolean or (Array of integers or numbers or strings or booleans)
One of:
One of:
integer
full_entitiesArray of strings or nullnon-emptyunique
orderArray of objectsnon-emptyrequired
order[].​descboolean
Default false
order[].​fieldstringrequired
order[].​nulls_lastboolean
Default false
paginationobject or null

Streaming response if absent or null, Paginated response otherwise

rollupstringrequired
start_timestring(date-time)
time_windowstringrequired
time_zonestring

Only in supported datasets: campaign, UTC or a time zone name defined in https://www.iana.org/time-zones

curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/reporting-api/openapi/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"
  }'

Responses

JSON for Paginated, JSONL for Streaming

Body
metaobject
resultsArray of objects
Response
{ "meta": { "items_count": 0, "page_index": 0, "status": "ok", "total_items_count": 0, "total_pages": 0 }, "results": [ {} ] }

Contextual Insights

Request

Standard performance metrics broken out by contextual categories that strategies are targeting

Fields

FieldTime WindowsRollups
Dimensions
agg_timestampcurrent_day, last_X_days, month_to_date, yesterdayby_day, by_month, by_week
advertiser_id
AnyAny
advertiser_name
AnyAny
agency_id
AnyAny
agency_name
AnyAny
attribution_group
AnyAny
campaign_ads_txt_verified
AnyAny
campaign_agency_fee_pct
AnyAny
campaign_archived
AnyAny
campaign_bid_min_devices
AnyAny
campaign_brain_intraday_pacing
AnyAny
campaign_connected_id_type
AnyAny
campaign_conversion_type
AnyAny
campaign_conversion_variable_minutes
AnyAny
campaign_cost_passthrough_cpm_enabled
AnyAny
campaign_cost_passthrough_cpm_value
AnyAny
campaign_cost_passthrough_percent_enabled
AnyAny
campaign_cost_passthrough_percent_value
AnyAny
campaign_created_on
Campaign Creation Time
AnyAny
campaign_currency_code
Campaign Currency Code
AnyAny
campaign_custom_attribution_source
AnyAny
campaign_dcs_data_is_campaign_level
AnyAny
campaign_device_graph_only
AnyAny
campaign_dynamic_budget_allocation_applied
AnyAny
campaign_dynamic_budget_allocation_available
AnyAny
campaign_dynamic_budget_allocation_type
AnyAny
campaign_end_date
(GMT) Campaign End Date
AnyAny
campaign_end_date_tz
(CTZ) Campaign End Date
AnyAny
campaign_frequency_amount
Campaign Frequency Amount
AnyAny
campaign_frequency_interval
Campaign Frequency Interval
AnyAny
campaign_frequency_optimization
Campaign Frequency Optimization
AnyAny
campaign_frequency_type
Campaign Frequency Type
AnyAny
campaign_goal_alert
AnyAny
campaign_goal_category
AnyAny
campaign_goal_type
AnyAny
campaign_goal_value
AnyAny
campaign_has_custom_attribution
AnyAny
campaign_id
AnyAny
campaign_impression_cap_amount
AnyAny
campaign_impression_cap_automatic
AnyAny
campaign_impression_cap_type
AnyAny
campaign_in_flight
In Flight
AnyAny
campaign_initial_start_date
(GMT) Campaign Initial Start Date
AnyAny
campaign_initial_start_date_tz
(CTZ) Campaign Initial Start Date
AnyAny
campaign_io_name
AnyAny
campaign_io_reference_num
AnyAny
campaign_is_programmatic_guaranteed
Campaign Is Programmatic Guaranteed
AnyAny
campaign_merit_pixel_id
AnyAny
campaign_minimize_multi_ads
Minimize Multi Ads
AnyAny
campaign_name
AnyAny
campaign_override_suspicious_traffic_filter
AnyAny
campaign_pacing_alert
AnyAny
campaign_pc_window_minutes
AnyAny
campaign_political
AnyAny
campaign_pv_pct
AnyAny
campaign_pv_window_minutes
AnyAny
campaign_restrict_targeting_to_deterministic_id
AnyAny
campaign_restrict_targeting_to_same_device_id
AnyAny
campaign_service_type
Campaign Service Type, a.k.a. Managed Service Flag / managed_service_flag
AnyAny
campaign_source_campaign_id
AnyAny
campaign_spend_cap_amount
AnyAny
campaign_spend_cap_automatic
AnyAny
campaign_spend_cap_daily_cap
AnyAny
campaign_spend_cap_type
AnyAny
campaign_start_date
(GMT) Campaign Start Date
AnyAny
campaign_start_date_tz
(CTZ) Campaign Start Date
AnyAny
campaign_status
Active Status
AnyAny
campaign_suspicious_traffic_filter_level
AnyAny
campaign_total_budget
AnyAny
campaign_total_impression_budget
Campaign Impressions Budget
AnyAny
campaign_updated_on
Campaign Update Time
AnyAny
campaign_version
AnyAny
campaign_zone_name
Campaign Time Zone, a.k.a time_zone
AnyAny
contextual_parent
AnyAny
contextual_path
AnyAny
contextual_target_id
AnyAny
contextual_target_name
AnyAny
contextual_vendor_name
AnyAny
exchange_id
AnyAny
exchange_name
AnyAny
node_id
AnyAny
organization_id
AnyAny
organization_name
AnyAny
strategy_ads_txt_verified
AnyAny
strategy_archived
AnyAny
strategy_audience_segment_exclude_op
AnyAny
strategy_audience_segment_include_op
AnyAny
strategy_bid_aggressiveness
AnyAny
strategy_bid_min_devices
AnyAny
strategy_bid_price_is_media_only
AnyAny
strategy_budget
AnyAny
strategy_cost_passthrough_cpm_enabled
AnyAny
strategy_cost_passthrough_cpm_value
AnyAny
strategy_cost_passthrough_percent_enabled
AnyAny
strategy_cost_passthrough_percent_value
AnyAny
strategy_created_on
AnyAny
strategy_currency_code
AnyAny
strategy_description
AnyAny
strategy_device_graph_only
AnyAny
strategy_end_date_raw
AnyAny
strategy_exchange_type_for_run_on_all
AnyAny
strategy_feature_compatibility
AnyAny
strategy_frequency_amount
AnyAny
strategy_frequency_interval
Campaign Frequency Interval
AnyAny
strategy_frequency_optimization
AnyAny
strategy_frequency_type
Campaign Frequency Type
AnyAny
strategy_goal_type
AnyAny
strategy_goal_value
AnyAny
strategy_groups
AnyAny
strategy_id
AnyAny
strategy_impression_pacing_amount
AnyAny
strategy_impression_pacing_interval
AnyAny
strategy_impression_pacing_type
AnyAny
strategy_max_bid
AnyAny
strategy_max_bid_wm
AnyAny
strategy_media_type
AnyAny
strategy_min_bid
AnyAny
strategy_name
AnyAny
strategy_pacing_amount
AnyAny
strategy_pacing_interval
AnyAny
strategy_pacing_optimization_amount
AnyAny
strategy_pacing_optimization_type
AnyAny
strategy_pacing_type
AnyAny
strategy_roi_target
AnyAny
strategy_run_on_all_exchanges
AnyAny
strategy_run_on_all_pmp
AnyAny
strategy_run_on_display
AnyAny
strategy_run_on_mobile
AnyAny
strategy_run_on_only_fraud_filtered_exchanges
AnyAny
strategy_run_on_streaming
AnyAny
strategy_site_restriction_transparent_urls
AnyAny
strategy_site_selectiveness
AnyAny
strategy_source_only
AnyAny
strategy_start_date_raw
AnyAny
strategy_status
Active Status
AnyAny
strategy_supply_type
AnyAny
strategy_targeting_segment_exclude_op
AnyAny
strategy_targeting_segment_include_op
AnyAny
strategy_type
AnyAny
strategy_updated_on
AnyAny
strategy_use_bid_shading
AnyAny
strategy_use_campaign_end
AnyAny
strategy_use_campaign_start
AnyAny
strategy_use_dba_strategy_pacing
AnyAny
strategy_use_dba_strategy_pacing_after_date
AnyAny
strategy_use_mm_freq
AnyAny
strategy_use_optimization
AnyAny
strategy_version
AnyAny
strategy_zone_name
AnyAny
vendor_id
AnyAny
Metrics
clicks
AnyAny
ctc
CTC
AnyAny
ctr
CTR
AnyAny
impressions
AnyAny
media_cost_roi
Media Cost ROI
AnyAny
post_click_aov
Post-Click AOV
AnyAny
post_click_conversions
Post-Click Conversions
AnyAny
post_click_revenue
Post-Click Revenue
AnyAny
post_click_total_spend_roi
Post-Click Total Spend ROI
AnyAny
post_view_aov
Post-View AOV
AnyAny
post_view_conversions
Post-View Conversions
AnyAny
post_view_conversions_raw
Post-View Conversions (Raw)
AnyAny
post_view_revenue
Post-View Revenue
AnyAny
post_view_revenue_raw
Post-View Revenue (Raw)
AnyAny
post_view_total_spend_roi
Post-View Total Spend ROI
AnyAny
revenue_raw
Revenue (Raw)
AnyAny
rr_per_1k_imps
Response Rate/1K Imps
AnyAny
total_aov
Total AOV
AnyAny
total_conversions
AnyAny
total_revenue
AnyAny
total_spend
AnyAny
total_spend_cpa
Total Spend eCPA
AnyAny
total_spend_cpc
Total Spend eCPC
AnyAny
total_spend_cpm
Total Spend eCPM
AnyAny
total_spend_pc_cpa
Total Spend PC CPA
AnyAny
total_spend_pv_cpa
Total Spend PV CPA
AnyAny
total_spend_roi
Total Spend ROI
AnyAny

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

Bodyapplication/jsonrequired
One of:
end_timestring or null(date-time)
fieldsArray of stringsnon-emptyuniquerequired
filtersArray of objectsnon-emptyrequired
filters[].​fieldstring
filters[].​filtersArray of objects or null>= 2 items
filters[].​opstring
  • =: Equals or contains if value 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 match
  • or: At least one filter must match
Default "="
filters[].​value(integer or number or string or boolean) or boolean or (Array of integers or numbers or strings or booleans)
One of:
One of:
integer
full_entitiesArray of strings or nullnon-emptyunique
orderArray of objectsnon-emptyrequired
order[].​descboolean
Default false
order[].​fieldstringrequired
order[].​nulls_lastboolean
Default false
rollupstringrequired
start_timestring(date-time)
time_windowstringrequired
time_zonestring

Only in supported datasets: campaign, UTC or a time zone name defined in https://www.iana.org/time-zones

curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/reporting-api/openapi/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"
  }'

Responses

JSON for Paginated, JSONL for Streaming

Bodyapplication/jsonl
string(Streaming Response)

Documentation available at https://apidocs.mediamath.com/docs/reporting-api-v2

Response
application/jsonl
"{\"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\"}"

Day Part Report

Request

Standard performance metrics broken out by time of day and day of week. Available in standard intervals.

Fields

FieldTime WindowsRollups
Dimensions
agg_timestampcurrent_day, last_X_days, month_to_date, yesterdayby_day, by_month, by_week
advertiser_id
AnyAny
advertiser_name
AnyAny
agency_id
AnyAny
agency_name
AnyAny
attribution_group
AnyAny
campaign_ads_txt_verified
AnyAny
campaign_agency_fee_pct
AnyAny
campaign_archived
AnyAny
campaign_bid_min_devices
AnyAny
campaign_brain_intraday_pacing
AnyAny
campaign_connected_id_type
AnyAny
campaign_conversion_type
AnyAny
campaign_conversion_variable_minutes
AnyAny
campaign_cost_passthrough_cpm_enabled
AnyAny
campaign_cost_passthrough_cpm_value
AnyAny
campaign_cost_passthrough_percent_enabled
AnyAny
campaign_cost_passthrough_percent_value
AnyAny
campaign_created_on
Campaign Creation Time
AnyAny
campaign_currency_code
Campaign Currency Code
AnyAny
campaign_custom_attribution_source
AnyAny
campaign_dcs_data_is_campaign_level
AnyAny
campaign_device_graph_only
AnyAny
campaign_dynamic_budget_allocation_applied
AnyAny
campaign_dynamic_budget_allocation_available
AnyAny
campaign_dynamic_budget_allocation_type
AnyAny
campaign_end_date
(GMT) Campaign End Date
AnyAny
campaign_end_date_tz
(CTZ) Campaign End Date
AnyAny
campaign_frequency_amount
Campaign Frequency Amount
AnyAny
campaign_frequency_interval
Campaign Frequency Interval
AnyAny
campaign_frequency_optimization
Campaign Frequency Optimization
AnyAny
campaign_frequency_type
Campaign Frequency Type
AnyAny
campaign_goal_alert
AnyAny
campaign_goal_category
AnyAny
campaign_goal_type
AnyAny
campaign_goal_value
AnyAny
campaign_has_custom_attribution
AnyAny
campaign_id
AnyAny
campaign_impression_cap_amount
AnyAny
campaign_impression_cap_automatic
AnyAny
campaign_impression_cap_type
AnyAny
campaign_in_flight
In Flight
AnyAny
campaign_initial_start_date
(GMT) Campaign Initial Start Date
AnyAny
campaign_initial_start_date_tz
(CTZ) Campaign Initial Start Date
AnyAny
campaign_io_name
AnyAny
campaign_io_reference_num
AnyAny
campaign_is_programmatic_guaranteed
Campaign Is Programmatic Guaranteed
AnyAny
campaign_merit_pixel_id
AnyAny
campaign_minimize_multi_ads
Minimize Multi Ads
AnyAny
campaign_name
AnyAny
campaign_override_suspicious_traffic_filter
AnyAny
campaign_pacing_alert
AnyAny
campaign_pc_window_minutes
AnyAny
campaign_political
AnyAny
campaign_pv_pct
AnyAny
campaign_pv_window_minutes
AnyAny
campaign_restrict_targeting_to_deterministic_id
AnyAny
campaign_restrict_targeting_to_same_device_id
AnyAny
campaign_service_type
Campaign Service Type, a.k.a. Managed Service Flag / managed_service_flag
AnyAny
campaign_source_campaign_id
AnyAny
campaign_spend_cap_amount
AnyAny
campaign_spend_cap_automatic
AnyAny
campaign_spend_cap_daily_cap
AnyAny
campaign_spend_cap_type
AnyAny
campaign_start_date
(GMT) Campaign Start Date
AnyAny
campaign_start_date_tz
(CTZ) Campaign Start Date
AnyAny
campaign_status
Active Status
AnyAny
campaign_suspicious_traffic_filter_level
AnyAny
campaign_total_budget
AnyAny
campaign_total_impression_budget
Campaign Impressions Budget
AnyAny
campaign_updated_on
Campaign Update Time
AnyAny
campaign_version
AnyAny
campaign_zone_name
Campaign Time Zone, a.k.a time_zone
AnyAny
day_part_id
Day Part ID
AnyAny
day_part_name
Day Part in the User's Timezone
AnyAny
exchange_id
AnyAny
exchange_name
AnyAny
organization_id
AnyAny
organization_name
AnyAny
strategy_ads_txt_verified
AnyAny
strategy_archived
AnyAny
strategy_audience_segment_exclude_op
AnyAny
strategy_audience_segment_include_op
AnyAny
strategy_bid_aggressiveness
AnyAny
strategy_bid_min_devices
AnyAny
strategy_bid_price_is_media_only
AnyAny
strategy_budget
AnyAny
strategy_cost_passthrough_cpm_enabled
AnyAny
strategy_cost_passthrough_cpm_value
AnyAny
strategy_cost_passthrough_percent_enabled
AnyAny
strategy_cost_passthrough_percent_value
AnyAny
strategy_created_on
AnyAny
strategy_currency_code
AnyAny
strategy_description
AnyAny
strategy_device_graph_only
AnyAny
strategy_end_date_raw
AnyAny
strategy_exchange_type_for_run_on_all
AnyAny
strategy_feature_compatibility
AnyAny
strategy_frequency_amount
AnyAny
strategy_frequency_interval
Campaign Frequency Interval
AnyAny
strategy_frequency_optimization
AnyAny
strategy_frequency_type
Campaign Frequency Type
AnyAny
strategy_goal_type
AnyAny
strategy_goal_value
AnyAny
strategy_groups
AnyAny
strategy_id
AnyAny
strategy_impression_pacing_amount
AnyAny
strategy_impression_pacing_interval
AnyAny
strategy_impression_pacing_type
AnyAny
strategy_max_bid
AnyAny
strategy_max_bid_wm
AnyAny
strategy_media_type
AnyAny
strategy_min_bid
AnyAny
strategy_name
AnyAny
strategy_pacing_amount
AnyAny
strategy_pacing_interval
AnyAny
strategy_pacing_optimization_amount
AnyAny
strategy_pacing_optimization_type
AnyAny
strategy_pacing_type
AnyAny
strategy_roi_target
AnyAny
strategy_run_on_all_exchanges
AnyAny
strategy_run_on_all_pmp
AnyAny
strategy_run_on_display
AnyAny
strategy_run_on_mobile
AnyAny
strategy_run_on_only_fraud_filtered_exchanges
AnyAny
strategy_run_on_streaming
AnyAny
strategy_site_restriction_transparent_urls
AnyAny
strategy_site_selectiveness
AnyAny
strategy_source_only
AnyAny
strategy_start_date_raw
AnyAny
strategy_status
Active Status
AnyAny
strategy_supply_type
AnyAny
strategy_targeting_segment_exclude_op
AnyAny
strategy_targeting_segment_include_op
AnyAny
strategy_type
AnyAny
strategy_updated_on
AnyAny
strategy_use_bid_shading
AnyAny
strategy_use_campaign_end
AnyAny
strategy_use_campaign_start
AnyAny
strategy_use_dba_strategy_pacing
AnyAny
strategy_use_dba_strategy_pacing_after_date
AnyAny
strategy_use_mm_freq
AnyAny
strategy_use_optimization
AnyAny
strategy_version
AnyAny
strategy_zone_name
AnyAny
week_day_id
Weekday ID
AnyAny
week_day_name
AnyAny
Metrics
clicks
AnyAny
ctc
CTC
AnyAny
ctr
CTR
AnyAny
impressions
AnyAny
post_click_conversions
Post-Click Conversions
AnyAny
post_view_conversions
Post-View Conversions
AnyAny
rr_per_1k_imps
Response Rate/1K Imps
AnyAny
total_conversions
AnyAny
total_spend
AnyAny
total_spend_cpa
Total Spend eCPA
AnyAny
total_spend_cpc
Total Spend eCPC
AnyAny
total_spend_cpcv
Total Spend eCPCV
AnyAny
total_spend_cpm
Total Spend eCPM
AnyAny
total_spend_pc_cpa
Total Spend PC CPA
AnyAny
total_spend_pv_cpa
Total Spend PV CPA
AnyAny
video_close
Close
AnyAny
video_collapse
Collapse
AnyAny
video_companion_clicks
Companion Clicks
AnyAny
video_companion_ctr
Companion CTR
AnyAny
video_companion_impressions
Companion Impressions
AnyAny
video_complete
100% Completed Views
AnyAny
video_complete_rate
100% Completed Rate
AnyAny
video_engaged_impressions
Engaged Impressions
AnyAny
video_engaged_rate
Engaged Rate
AnyAny
video_expand
Expand
AnyAny
video_first_quartile
25% Completed Views
AnyAny
video_first_quartile_rate
25% Completed Rate
AnyAny
video_fullscreen
Fullscreen
AnyAny
video_midpoint
50% Completed Views
AnyAny
video_midpoint_rate
50% Completed Rate
AnyAny
video_mute
Mute
AnyAny
video_pause
Pause
AnyAny
video_play_rate
Play Rate
AnyAny
video_resume
Resume
AnyAny
video_rewind
Rewind
AnyAny
video_skip
Skip
AnyAny
video_skippable_impressions
Skippable Impressions
AnyAny
video_skipped_impressions
Skipped Impressions
AnyAny
video_skipped_rate
Skipped Rate
AnyAny
video_start
Start
AnyAny
video_third_quartile
75% Completed Views
AnyAny
video_third_quartile_rate
75% Completed Rate
AnyAny
video_unmute
Unmute
AnyAny

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

Bodyapplication/jsonrequired
One of:
end_timestring or null(date-time)
fieldsArray of stringsnon-emptyuniquerequired
filtersArray of objectsnon-emptyrequired
filters[].​fieldstring
filters[].​filtersArray of objects or null>= 2 items
filters[].​opstring
  • =: Equals or contains if value 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 match
  • or: At least one filter must match
Default "="
filters[].​value(integer or number or string or boolean) or boolean or (Array of integers or numbers or strings or booleans)
One of:
One of:
integer
full_entitiesArray of strings or nullnon-emptyunique
orderArray of objectsnon-emptyrequired
order[].​descboolean
Default false
order[].​fieldstringrequired
order[].​nulls_lastboolean
Default false
rollupstringrequired
start_timestring(date-time)
time_windowstringrequired
time_zonestring

Only in supported datasets: campaign, UTC or a time zone name defined in https://www.iana.org/time-zones

curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/reporting-api/openapi/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"
  }'

Responses

JSON for Paginated, JSONL for Streaming

Bodyapplication/jsonl
string(Streaming Response)

Documentation available at https://apidocs.mediamath.com/docs/reporting-api-v2

Response
application/jsonl
"{\"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\"}"

Deals

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

FieldTime WindowsRollups
Dimensions
agg_timestampcurrent_day, last_X_days, last_X_hours, month_to_date, yesterdayby_day, by_hour, by_month, by_week
deal_exchange_id
AnyAny
deal_external_id
AnyAny
deal_group_id
AnyAny
deal_group_name
AnyAny
deal_id
AnyAny
deal_name
AnyAny
deal_organization_id
AnyAny
deal_price_type
AnyAny
deal_publisher_id
Deal Publisher ID
AnyAny
Metrics
bid_rate
AnyAny
biddables
AnyAny
bids
AnyAny
matches
AnyAny
win_rate
AnyAny
wins
AnyAny

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

Bodyapplication/jsonrequired
One of:
end_timestring or null(date-time)
fieldsArray of stringsnon-emptyuniquerequired
filtersArray of objectsnon-emptyrequired
filters[].​fieldstring
filters[].​filtersArray of objects or null>= 2 items
filters[].​opstring
  • =: Equals or contains if value 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 match
  • or: At least one filter must match
Default "="
filters[].​value(integer or number or string or boolean) or boolean or (Array of integers or numbers or strings or booleans)
One of:
One of:
integer
full_entitiesArray of strings or nullnon-emptyunique
orderArray of objectsnon-emptyrequired
order[].​descboolean
Default false
order[].​fieldstringrequired
order[].​nulls_lastboolean
Default false
rollupstringrequired
start_timestring(date-time)
time_windowstringrequired
time_zonestring

Only in supported datasets: campaign, UTC or a time zone name defined in https://www.iana.org/time-zones

curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/reporting-api/openapi/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"
  }'

Responses

JSON for Paginated, JSONL for Streaming

Bodyapplication/jsonl
string(Streaming Response)

Documentation available at https://apidocs.mediamath.com/docs/reporting-api-v2

Response
application/jsonl
"{\"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\"}"

Hyperlocal Report

Request

Standard performance metrics broken out by Hyperlocal Targeting objects created via third party.

Fields

FieldTime WindowsRollups
Dimensions
agg_timestampcurrent_day, last_X_days, month_to_date, yesterdayby_day, by_month, by_week
advertiser_id
AnyAny
advertiser_name
AnyAny
agency_id
AnyAny
agency_name
AnyAny
attribution_group
AnyAny
campaign_ads_txt_verified
AnyAny
campaign_agency_fee_pct
AnyAny
campaign_archived
AnyAny
campaign_bid_min_devices
AnyAny
campaign_brain_intraday_pacing
AnyAny
campaign_connected_id_type
AnyAny
campaign_conversion_type
AnyAny
campaign_conversion_variable_minutes
AnyAny
campaign_cost_passthrough_cpm_enabled
AnyAny
campaign_cost_passthrough_cpm_value
AnyAny
campaign_cost_passthrough_percent_enabled
AnyAny
campaign_cost_passthrough_percent_value
AnyAny
campaign_created_on
Campaign Creation Time
AnyAny
campaign_currency_code
Campaign Currency Code
AnyAny
campaign_custom_attribution_source
AnyAny
campaign_dcs_data_is_campaign_level
AnyAny
campaign_device_graph_only
AnyAny
campaign_dynamic_budget_allocation_applied
AnyAny
campaign_dynamic_budget_allocation_available
AnyAny
campaign_dynamic_budget_allocation_type
AnyAny
campaign_end_date
(GMT) Campaign End Date
AnyAny
campaign_end_date_tz
(CTZ) Campaign End Date
AnyAny
campaign_frequency_amount
Campaign Frequency Amount
AnyAny
campaign_frequency_interval
Campaign Frequency Interval
AnyAny
campaign_frequency_optimization
Campaign Frequency Optimization
AnyAny
campaign_frequency_type
Campaign Frequency Type
AnyAny
campaign_goal_alert
AnyAny
campaign_goal_category
AnyAny
campaign_goal_type
AnyAny
campaign_goal_value
AnyAny
campaign_has_custom_attribution
AnyAny
campaign_id
AnyAny
campaign_impression_cap_amount
AnyAny
campaign_impression_cap_automatic
AnyAny
campaign_impression_cap_type
AnyAny
campaign_in_flight
In Flight
AnyAny
campaign_initial_start_date
(GMT) Campaign Initial Start Date
AnyAny
campaign_initial_start_date_tz
(CTZ) Campaign Initial Start Date
AnyAny
campaign_io_name
AnyAny
campaign_io_reference_num
AnyAny
campaign_is_programmatic_guaranteed
Campaign Is Programmatic Guaranteed
AnyAny
campaign_merit_pixel_id
AnyAny
campaign_minimize_multi_ads
Minimize Multi Ads
AnyAny
campaign_name
AnyAny
campaign_override_suspicious_traffic_filter
AnyAny
campaign_pacing_alert
AnyAny
campaign_pc_window_minutes
AnyAny
campaign_political
AnyAny
campaign_pv_pct
AnyAny
campaign_pv_window_minutes
AnyAny
campaign_restrict_targeting_to_deterministic_id
AnyAny
campaign_restrict_targeting_to_same_device_id
AnyAny
campaign_service_type
Campaign Service Type, a.k.a. Managed Service Flag / managed_service_flag
AnyAny
campaign_source_campaign_id
AnyAny
campaign_spend_cap_amount
AnyAny
campaign_spend_cap_automatic
AnyAny
campaign_spend_cap_daily_cap
AnyAny
campaign_spend_cap_type
AnyAny
campaign_start_date
(GMT) Campaign Start Date
AnyAny
campaign_start_date_tz
(CTZ) Campaign Start Date
AnyAny
campaign_status
Active Status
AnyAny
campaign_suspicious_traffic_filter_level
AnyAny
campaign_total_budget
AnyAny
campaign_total_impression_budget
Campaign Impressions Budget
AnyAny
campaign_updated_on
Campaign Update Time
AnyAny
campaign_version
AnyAny
campaign_zone_name
Campaign Time Zone, a.k.a time_zone
AnyAny
exchange_id
AnyAny
exchange_name
AnyAny
node_level
AnyAny
organization_id
AnyAny
organization_name
AnyAny
path
AnyAny
postal_code
AnyAny
strategy_ads_txt_verified
AnyAny
strategy_archived
AnyAny
strategy_audience_segment_exclude_op
AnyAny
strategy_audience_segment_include_op
AnyAny
strategy_bid_aggressiveness
AnyAny
strategy_bid_min_devices
AnyAny
strategy_bid_price_is_media_only
AnyAny
strategy_budget
AnyAny
strategy_cost_passthrough_cpm_enabled
AnyAny
strategy_cost_passthrough_cpm_value
AnyAny
strategy_cost_passthrough_percent_enabled
AnyAny
strategy_cost_passthrough_percent_value
AnyAny
strategy_created_on
AnyAny
strategy_currency_code
AnyAny
strategy_description
AnyAny
strategy_device_graph_only
AnyAny
strategy_end_date_raw
AnyAny
strategy_exchange_type_for_run_on_all
AnyAny
strategy_feature_compatibility
AnyAny
strategy_frequency_amount
AnyAny
strategy_frequency_interval
Campaign Frequency Interval
AnyAny
strategy_frequency_optimization
AnyAny
strategy_frequency_type
Campaign Frequency Type
AnyAny
strategy_goal_type
AnyAny
strategy_goal_value
AnyAny
strategy_groups
AnyAny
strategy_id
AnyAny
strategy_impression_pacing_amount
AnyAny
strategy_impression_pacing_interval
AnyAny
strategy_impression_pacing_type
AnyAny
strategy_max_bid
AnyAny
strategy_max_bid_wm
AnyAny
strategy_media_type
AnyAny
strategy_min_bid
AnyAny
strategy_name
AnyAny
strategy_pacing_amount
AnyAny
strategy_pacing_interval
AnyAny
strategy_pacing_optimization_amount
AnyAny
strategy_pacing_optimization_type
AnyAny
strategy_pacing_type
AnyAny
strategy_roi_target
AnyAny
strategy_run_on_all_exchanges
AnyAny
strategy_run_on_all_pmp
AnyAny
strategy_run_on_display
AnyAny
strategy_run_on_mobile
AnyAny
strategy_run_on_only_fraud_filtered_exchanges
AnyAny
strategy_run_on_streaming
AnyAny
strategy_site_restriction_transparent_urls
AnyAny
strategy_site_selectiveness
AnyAny
strategy_source_only
AnyAny
strategy_start_date_raw
AnyAny
strategy_status
Active Status
AnyAny
strategy_supply_type
AnyAny
strategy_targeting_segment_exclude_op
AnyAny
strategy_targeting_segment_include_op
AnyAny
strategy_type
AnyAny
strategy_updated_on
AnyAny
strategy_use_bid_shading
AnyAny
strategy_use_campaign_end
AnyAny
strategy_use_campaign_start
AnyAny
strategy_use_dba_strategy_pacing
AnyAny
strategy_use_dba_strategy_pacing_after_date
AnyAny
strategy_use_mm_freq
AnyAny
strategy_use_optimization
AnyAny
strategy_version
AnyAny
strategy_zone_name
AnyAny
target_id
AnyAny
Metrics
clicks
AnyAny
ctc
CTC
AnyAny
ctr
CTR
AnyAny
impressions
AnyAny
media_cost_roi
Media Cost ROI
AnyAny
post_click_aov
Post-Click AOV
AnyAny
post_click_conversions
Post-Click Conversions
AnyAny
post_click_revenue
Post-Click Revenue
AnyAny
post_click_total_spend_roi
Post-Click Total Spend ROI
AnyAny
post_view_aov
Post-View AOV
AnyAny
post_view_conversions
Post-View Conversions
AnyAny
post_view_conversions_raw
Post-View Conversions (Raw)
AnyAny
post_view_revenue
Post-View Revenue
AnyAny
post_view_revenue_raw
Post-View Revenue (Raw)
AnyAny
post_view_total_spend_roi
Post-View Total Spend ROI
AnyAny
revenue_raw
Revenue (Raw)
AnyAny
rr_per_1k_imps
Response Rate/1K Imps
AnyAny
total_aov
Total AOV
AnyAny
total_conversions
AnyAny
total_revenue
AnyAny
total_spend
AnyAny
total_spend_cpa
Total Spend eCPA
AnyAny
total_spend_cpc
Total Spend eCPC
AnyAny
total_spend_cpm
Total Spend eCPM
AnyAny
total_spend_pc_cpa
Total Spend PC CPA
AnyAny
total_spend_pv_cpa
Total Spend PV CPA
AnyAny
total_spend_roi
Total Spend ROI
AnyAny

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

Bodyapplication/jsonrequired
One of:
end_timestring or null(date-time)
fieldsArray of stringsnon-emptyuniquerequired
filtersArray of objectsnon-emptyrequired
filters[].​fieldstring
filters[].​filtersArray of objects or null>= 2 items
filters[].​opstring
  • =: Equals or contains if value 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 match
  • or: At least one filter must match
Default "="
filters[].​value(integer or number or string or boolean) or boolean or (Array of integers or numbers or strings or booleans)
One of:
One of:
integer
full_entitiesArray of strings or nullnon-emptyunique
orderArray of objectsnon-emptyrequired
order[].​descboolean
Default false
order[].​fieldstringrequired
order[].​nulls_lastboolean
Default false
rollupstringrequired
start_timestring(date-time)
time_windowstringrequired
time_zonestring

Only in supported datasets: campaign, UTC or a time zone name defined in https://www.iana.org/time-zones

curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/reporting-api/openapi/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"
  }'

Responses

JSON for Paginated, JSONL for Streaming

Bodyapplication/jsonl
string(Streaming Response)

Documentation available at https://apidocs.mediamath.com/docs/reporting-api-v2

Response
application/jsonl
"{\"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\"}"

Performance

Request

Standard Aggregated Performance Report in Campaign Currency

Fields

FieldTime WindowsRollups
Dimensions
agg_timestampcurrent_day, last_X_days, month_to_date, yesterdayby_day, by_month, by_week
advertiser_id
AnyAny
advertiser_name
AnyAny
agency_id
AnyAny
agency_name
AnyAny
attribution_group
AnyAny
campaign_ads_txt_verified
AnyAny
campaign_agency_fee_pct
AnyAny
campaign_archived
AnyAny
campaign_bid_min_devices
AnyAny
campaign_brain_intraday_pacing
AnyAny
campaign_connected_id_type
AnyAny
campaign_conversion_type
AnyAny
campaign_conversion_variable_minutes
AnyAny
campaign_cost_passthrough_cpm_enabled
AnyAny
campaign_cost_passthrough_cpm_value
AnyAny
campaign_cost_passthrough_percent_enabled
AnyAny
campaign_cost_passthrough_percent_value
AnyAny
campaign_created_on
Campaign Creation Time
AnyAny
campaign_currency_code
Campaign Currency Code
AnyAny
campaign_custom_attribution_source
AnyAny
campaign_dcs_data_is_campaign_level
AnyAny
campaign_device_graph_only
AnyAny
campaign_dynamic_budget_allocation_applied
AnyAny
campaign_dynamic_budget_allocation_available
AnyAny
campaign_dynamic_budget_allocation_type
AnyAny
campaign_end_date
(GMT) Campaign End Date
AnyAny
campaign_end_date_tz
(CTZ) Campaign End Date
AnyAny
campaign_frequency_amount
Campaign Frequency Amount
AnyAny
campaign_frequency_interval
Campaign Frequency Interval
AnyAny
campaign_frequency_optimization
Campaign Frequency Optimization
AnyAny
campaign_frequency_type
Campaign Frequency Type
AnyAny
campaign_goal_alert
AnyAny
campaign_goal_category
AnyAny
campaign_goal_type
AnyAny
campaign_goal_value
AnyAny
campaign_has_custom_attribution
AnyAny
campaign_id
AnyAny
campaign_impression_cap_amount
AnyAny
campaign_impression_cap_automatic
AnyAny
campaign_impression_cap_type
AnyAny
campaign_in_flight
In Flight
AnyAny
campaign_initial_start_date
(GMT) Campaign Initial Start Date
AnyAny
campaign_initial_start_date_tz
(CTZ) Campaign Initial Start Date
AnyAny
campaign_io_name
AnyAny
campaign_io_reference_num
AnyAny
campaign_is_programmatic_guaranteed
Campaign Is Programmatic Guaranteed
AnyAny
campaign_merit_pixel_id
AnyAny
campaign_minimize_multi_ads
Minimize Multi Ads
AnyAny
campaign_name
AnyAny
campaign_override_suspicious_traffic_filter
AnyAny
campaign_pacing_alert
AnyAny
campaign_pc_window_minutes
AnyAny
campaign_political
AnyAny
campaign_pv_pct
AnyAny
campaign_pv_window_minutes
AnyAny
campaign_restrict_targeting_to_deterministic_id
AnyAny
campaign_restrict_targeting_to_same_device_id
AnyAny
campaign_service_type
Campaign Service Type, a.k.a. Managed Service Flag / managed_service_flag
AnyAny
campaign_source_campaign_id
AnyAny
campaign_spend_cap_amount
AnyAny
campaign_spend_cap_automatic
AnyAny
campaign_spend_cap_daily_cap
AnyAny
campaign_spend_cap_type
AnyAny
campaign_start_date
(GMT) Campaign Start Date
AnyAny
campaign_start_date_tz
(CTZ) Campaign Start Date
AnyAny
campaign_status
Active Status
AnyAny
campaign_suspicious_traffic_filter_level
AnyAny
campaign_total_budget
AnyAny
campaign_total_impression_budget
Campaign Impressions Budget
AnyAny
campaign_updated_on
Campaign Update Time
AnyAny
campaign_version
AnyAny
campaign_zone_name
Campaign Time Zone, a.k.a time_zone
AnyAny
concept_id
AnyAny
concept_name
AnyAny
creative_file_type
AnyAny
creative_has_sound
AnyAny
creative_id
AnyAny
creative_is_native
AnyAny
creative_name
AnyAny
creative_rich_media
AnyAny
creative_size
AnyAny
creative_tpas_placement_id
AnyAny
creative_tpas_placement_name
AnyAny
deal_exchange_id
AnyAny
deal_external_id
AnyAny
deal_group_id
AnyAny
deal_group_name
AnyAny
deal_id
AnyAny
deal_name
AnyAny
deal_organization_id
AnyAny
deal_price_type
AnyAny
deal_publisher_id
Deal Publisher ID
AnyAny
exchange_id
AnyAny
exchange_name
AnyAny
flight_id
AnyAny
organization_id
AnyAny
organization_name
AnyAny
prisma_campaign_id
AnyAny
prisma_client_product_estimate
AnyAny
prisma_io_number
AnyAny
strategy_ads_txt_verified
AnyAny
strategy_archived
AnyAny
strategy_audience_segment_exclude_op
AnyAny
strategy_audience_segment_include_op
AnyAny
strategy_bid_aggressiveness
AnyAny
strategy_bid_min_devices
AnyAny
strategy_bid_price_is_media_only
AnyAny
strategy_budget
AnyAny
strategy_cost_passthrough_cpm_enabled
AnyAny
strategy_cost_passthrough_cpm_value
AnyAny
strategy_cost_passthrough_percent_enabled
AnyAny
strategy_cost_passthrough_percent_value
AnyAny
strategy_created_on
AnyAny
strategy_currency_code
AnyAny
strategy_description
AnyAny
strategy_device_graph_only
AnyAny
strategy_end_date_raw
AnyAny
strategy_exchange_type_for_run_on_all
AnyAny
strategy_feature_compatibility
AnyAny
strategy_frequency_amount
AnyAny
strategy_frequency_interval
Campaign Frequency Interval
AnyAny
strategy_frequency_optimization
AnyAny
strategy_frequency_type
Campaign Frequency Type
AnyAny
strategy_goal_type
AnyAny
strategy_goal_value
AnyAny
strategy_groups
AnyAny
strategy_id
AnyAny
strategy_impression_pacing_amount
AnyAny
strategy_impression_pacing_interval
AnyAny
strategy_impression_pacing_type
AnyAny
strategy_max_bid
AnyAny
strategy_max_bid_wm
AnyAny
strategy_media_type
AnyAny
strategy_min_bid
AnyAny
strategy_name
AnyAny
strategy_pacing_amount
AnyAny
strategy_pacing_interval
AnyAny
strategy_pacing_optimization_amount
AnyAny
strategy_pacing_optimization_type
AnyAny
strategy_pacing_type
AnyAny
strategy_roi_target
AnyAny
strategy_run_on_all_exchanges
AnyAny
strategy_run_on_all_pmp
AnyAny
strategy_run_on_display
AnyAny
strategy_run_on_mobile
AnyAny
strategy_run_on_only_fraud_filtered_exchanges
AnyAny
strategy_run_on_streaming
AnyAny
strategy_site_restriction_transparent_urls
AnyAny
strategy_site_selectiveness
AnyAny
strategy_source_only
AnyAny
strategy_start_date_raw
AnyAny
strategy_status
Active Status
AnyAny
strategy_supply_type
AnyAny
strategy_targeting_segment_exclude_op
AnyAny
strategy_targeting_segment_include_op
AnyAny
strategy_type
AnyAny
strategy_updated_on
AnyAny
strategy_use_bid_shading
AnyAny
strategy_use_campaign_end
AnyAny
strategy_use_campaign_start
AnyAny
strategy_use_dba_strategy_pacing
AnyAny
strategy_use_dba_strategy_pacing_after_date
AnyAny
strategy_use_mm_freq
AnyAny
strategy_use_optimization
AnyAny
strategy_version
AnyAny
strategy_zone_name
AnyAny
Metrics
clicks
AnyAny
ctc
CTC
AnyAny
ctr
CTR
AnyAny
impressions
AnyAny
in_view
In View Impressions
AnyAny
in_view_100_percent
100% In View Impressions
AnyAny
in_view_15_seconds
AnyAny
in_view_15_seconds_rate
AnyAny
in_view_5_seconds
AnyAny
in_view_5_seconds_rate
AnyAny
measurability_rate
Measurability Rate
AnyAny
measurable
Measurable Impressions
AnyAny
post_click_aov
Post-Click AOV
AnyAny
post_click_conversions
Post-Click Conversions
AnyAny
post_click_revenue
Post-Click Revenue
AnyAny
post_click_revenue_usd
AnyAny
post_click_total_spend_roi
Post-Click Total Spend ROI
AnyAny
post_view_aov
Post-View AOV
AnyAny
post_view_conversions
Post-View Conversions
AnyAny
post_view_conversions_raw
Post-View Conversions (Raw)
AnyAny
post_view_revenue
Post-View Revenue
AnyAny
post_view_revenue_raw
Post-View Revenue (Raw)
AnyAny
post_view_revenue_raw_usd
AnyAny
post_view_total_spend_roi
Post-View Total Spend ROI
AnyAny
revenue
Revenue (Raw)
AnyAny
rr_per_1k_imps
Response Rate/1K Imps
AnyAny
total_aov
Total AOV
AnyAny
total_conversions
AnyAny
total_revenue
AnyAny
total_spend
AnyAny
total_spend_cpa
Total Spend eCPA
AnyAny
total_spend_cpc
Total Spend eCPC
AnyAny
total_spend_cpcv
Total Spend eCPCV
AnyAny
total_spend_cpm
Total Spend eCPM
AnyAny
total_spend_pc_cpa
Total Spend PC CPA
AnyAny
total_spend_pv_cpa
Total Spend PV CPA
AnyAny
total_spend_roi
Total Spend ROI
AnyAny
total_spend_usd
AnyAny
total_spend_vcpm
Total Spend vCPM
AnyAny
tpa_conversions
3PA Total Conversions
AnyAny
tpa_total_aov
3PA Total AOV
AnyAny
tpa_total_aov_usd
(USD) 3PA Total AOV
AnyAny
tpa_total_revenue
3PA Total Revenue
AnyAny
tpa_total_revenue_usd
(USD) 3PA Total Revenue
AnyAny
tpa_total_spend_cpa
3PA Total Spend CPA
AnyAny
tpa_total_spend_cpa_usd
(USD) 3PA Total Spend CPA
AnyAny
tpa_total_spend_roi
3PA Total Spend ROI
AnyAny
uniques
current_day, last_X_days, month_to_date, yesterdayall, by_day, by_month, by_week
video_close
Close
AnyAny
video_collapse
Collapse
AnyAny
video_companion_clicks
Companion Clicks
AnyAny
video_companion_ctr
Companion CTR
AnyAny
video_companion_impressions
Companion Impressions
AnyAny
video_complete
100% Completed Views
AnyAny
video_complete_rate
100% Completed Rate
AnyAny
video_complete_rate_impression_based
VCR (Impression Based)
AnyAny
video_engaged_impressions
Engaged Impressions
AnyAny
video_engaged_rate
Engaged Rate
AnyAny
video_expand
Expand
AnyAny
video_first_quartile
25% Completed Views
AnyAny
video_first_quartile_rate
25% Completed Rate
AnyAny
video_first_quartile_rate_impression_based
25% Completed Rate - Impressions Based
AnyAny
video_fullscreen
Fullscreen
AnyAny
video_midpoint
50% Completed Views
AnyAny
video_midpoint_rate
50% Completed Rate
AnyAny
video_midpoint_rate_impression_based
50% Completed Rate - Impressions Based
AnyAny
video_mute
AnyAny
video_pause
Pause
AnyAny
video_play_rate
Play Rate
AnyAny
video_resume
Resume
AnyAny
video_rewind
Rewind
AnyAny
video_skip
Skip
AnyAny
video_skippable_impressions
Skippable Impressions
AnyAny
video_skipped_impressions
Skipped Impressions
AnyAny
video_skipped_rate
Skipped Rate
AnyAny
video_start
Start
AnyAny
video_third_quartile
75% Completed Views
AnyAny
video_third_quartile_rate
75% Completed Rate
AnyAny
video_third_quartile_rate_impression_based
75% Completed Rate - Impressions Based
AnyAny
video_unmute
AnyAny
viewability_rate
Viewability Rate
AnyAny
viewability_rate_100_percent
100% In View Rate
AnyAny

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

Bodyapplication/jsonrequired
One of:
end_timestring or null(date-time)
fieldsArray of stringsnon-emptyuniquerequired
filtersArray of objectsnon-emptyrequired
filters[].​fieldstring
filters[].​filtersArray of objects or null>= 2 items
filters[].​opstring
  • =: Equals or contains if value 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 match
  • or: At least one filter must match
Default "="
filters[].​value(integer or number or string or boolean) or boolean or (Array of integers or numbers or strings or booleans)
One of:
One of:
integer
full_entitiesArray of strings or nullnon-emptyunique
orderArray of objectsnon-emptyrequired
order[].​descboolean
Default false
order[].​fieldstringrequired
order[].​nulls_lastboolean
Default false
rollupstringrequired
start_timestring(date-time)
time_windowstringrequired
time_zonestring

Only in supported datasets: campaign, UTC or a time zone name defined in https://www.iana.org/time-zones

curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/reporting-api/openapi/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"
  }'

Responses

JSON for Paginated, JSONL for Streaming

Bodyapplication/jsonl
string(Streaming Response)

Documentation available at https://apidocs.mediamath.com/docs/reporting-api-v2

Response
application/jsonl
"{\"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\"}"

Performance Hourly

Request

Standard Aggregated Performance Report in Campaign Currency

Fields

FieldTime WindowsRollups
Dimensions
agg_timestampcurrent_day, last_X_days, last_X_hours, month_to_date, yesterdayby_day, by_hour, by_month, by_week
advertiser_id
AnyAny
advertiser_name
AnyAny
agency_id
AnyAny
agency_name
AnyAny
campaign_ads_txt_verified
AnyAny
campaign_agency_fee_pct
AnyAny
campaign_archived
AnyAny
campaign_bid_min_devices
AnyAny
campaign_brain_intraday_pacing
AnyAny
campaign_connected_id_type
AnyAny
campaign_conversion_type
AnyAny
campaign_conversion_variable_minutes
AnyAny
campaign_cost_passthrough_cpm_enabled
AnyAny
campaign_cost_passthrough_cpm_value
AnyAny
campaign_cost_passthrough_percent_enabled
AnyAny
campaign_cost_passthrough_percent_value
AnyAny
campaign_created_on
Campaign Creation Time
AnyAny
campaign_currency_code
Campaign Currency Code
AnyAny
campaign_custom_attribution_source
AnyAny
campaign_dcs_data_is_campaign_level
AnyAny
campaign_device_graph_only
AnyAny
campaign_dynamic_budget_allocation_applied
AnyAny
campaign_dynamic_budget_allocation_available
AnyAny
campaign_dynamic_budget_allocation_type
AnyAny
campaign_end_date
(GMT) Campaign End Date
AnyAny
campaign_end_date_tz
(CTZ) Campaign End Date
AnyAny
campaign_frequency_amount
Campaign Frequency Amount
AnyAny
campaign_frequency_interval
Campaign Frequency Interval
AnyAny
campaign_frequency_optimization
Campaign Frequency Optimization
AnyAny
campaign_frequency_type
Campaign Frequency Type
AnyAny
campaign_goal_alert
AnyAny
campaign_goal_category
AnyAny
campaign_goal_type
AnyAny
campaign_goal_value
AnyAny
campaign_has_custom_attribution
AnyAny
campaign_id
AnyAny
campaign_impression_cap_amount
AnyAny
campaign_impression_cap_automatic
AnyAny
campaign_impression_cap_type
AnyAny
campaign_in_flight
In Flight
AnyAny
campaign_initial_start_date
(GMT) Campaign Initial Start Date
AnyAny
campaign_initial_start_date_tz
(CTZ) Campaign Initial Start Date
AnyAny
campaign_io_name
AnyAny
campaign_io_reference_num
AnyAny
campaign_is_programmatic_guaranteed
Campaign Is Programmatic Guaranteed
AnyAny
campaign_merit_pixel_id
AnyAny
campaign_minimize_multi_ads
Minimize Multi Ads
AnyAny
campaign_name
AnyAny
campaign_override_suspicious_traffic_filter
AnyAny
campaign_pacing_alert
AnyAny
campaign_pc_window_minutes
AnyAny
campaign_political
AnyAny
campaign_pv_pct
AnyAny
campaign_pv_window_minutes
AnyAny
campaign_restrict_targeting_to_deterministic_id
AnyAny
campaign_restrict_targeting_to_same_device_id
AnyAny
campaign_service_type
Campaign Service Type, a.k.a. Managed Service Flag / managed_service_flag
AnyAny
campaign_source_campaign_id
AnyAny
campaign_spend_cap_amount
AnyAny
campaign_spend_cap_automatic
AnyAny
campaign_spend_cap_daily_cap
AnyAny
campaign_spend_cap_type
AnyAny
campaign_start_date
(GMT) Campaign Start Date
AnyAny
campaign_start_date_tz
(CTZ) Campaign Start Date
AnyAny
campaign_status
Active Status
AnyAny
campaign_suspicious_traffic_filter_level
AnyAny
campaign_total_budget
AnyAny
campaign_total_impression_budget
Campaign Impressions Budget
AnyAny
campaign_updated_on
Campaign Update Time
AnyAny
campaign_version
AnyAny
campaign_zone_name
Campaign Time Zone, a.k.a time_zone
AnyAny
flight_id
AnyAny
organization_id
AnyAny
organization_name
AnyAny
prisma_campaign_id
AnyAny
prisma_client_product_estimate
AnyAny
prisma_io_number
AnyAny
strategy_ads_txt_verified
AnyAny
strategy_archived
AnyAny
strategy_audience_segment_exclude_op
AnyAny
strategy_audience_segment_include_op
AnyAny
strategy_bid_aggressiveness
AnyAny
strategy_bid_min_devices
AnyAny
strategy_bid_price_is_media_only
AnyAny
strategy_budget
AnyAny
strategy_cost_passthrough_cpm_enabled
AnyAny
strategy_cost_passthrough_cpm_value
AnyAny
strategy_cost_passthrough_percent_enabled
AnyAny
strategy_cost_passthrough_percent_value
AnyAny
strategy_created_on
AnyAny
strategy_currency_code
AnyAny
strategy_description
AnyAny
strategy_device_graph_only
AnyAny
strategy_end_date_raw
AnyAny
strategy_exchange_type_for_run_on_all
AnyAny
strategy_feature_compatibility
AnyAny
strategy_frequency_amount
AnyAny
strategy_frequency_interval
Campaign Frequency Interval
AnyAny
strategy_frequency_optimization
AnyAny
strategy_frequency_type
Campaign Frequency Type
AnyAny
strategy_goal_type
AnyAny
strategy_goal_value
AnyAny
strategy_groups
AnyAny
strategy_id
AnyAny
strategy_impression_pacing_amount
AnyAny
strategy_impression_pacing_interval
AnyAny
strategy_impression_pacing_type
AnyAny
strategy_max_bid
AnyAny
strategy_max_bid_wm
AnyAny
strategy_media_type
AnyAny
strategy_min_bid
AnyAny
strategy_name
AnyAny
strategy_pacing_amount
AnyAny
strategy_pacing_interval
AnyAny
strategy_pacing_optimization_amount
AnyAny
strategy_pacing_optimization_type
AnyAny
strategy_pacing_type
AnyAny
strategy_roi_target
AnyAny
strategy_run_on_all_exchanges
AnyAny
strategy_run_on_all_pmp
AnyAny
strategy_run_on_display
AnyAny
strategy_run_on_mobile
AnyAny
strategy_run_on_only_fraud_filtered_exchanges
AnyAny
strategy_run_on_streaming
AnyAny
strategy_site_restriction_transparent_urls
AnyAny
strategy_site_selectiveness
AnyAny
strategy_source_only
AnyAny
strategy_start_date_raw
AnyAny
strategy_status
Active Status
AnyAny
strategy_supply_type
AnyAny
strategy_targeting_segment_exclude_op
AnyAny
strategy_targeting_segment_include_op
AnyAny
strategy_type
AnyAny
strategy_updated_on
AnyAny
strategy_use_bid_shading
AnyAny
strategy_use_campaign_end
AnyAny
strategy_use_campaign_start
AnyAny
strategy_use_dba_strategy_pacing
AnyAny
strategy_use_dba_strategy_pacing_after_date
AnyAny
strategy_use_mm_freq
AnyAny
strategy_use_optimization
AnyAny
strategy_version
AnyAny
strategy_zone_name
AnyAny
Metrics
clicks
AnyAny
ctc
CTC
AnyAny
ctr
CTR
AnyAny
impressions
AnyAny
in_view
In View Impressions
AnyAny
in_view_100_percent
100% In View Impressions
AnyAny
in_view_15_seconds
AnyAny
in_view_15_seconds_rate
AnyAny
in_view_5_seconds
AnyAny
in_view_5_seconds_rate
AnyAny
measurability_rate
Measurability Rate
AnyAny
measurable
Measurable Impressions
AnyAny
post_click_aov
Post-Click AOV
AnyAny
post_click_conversions
Post-Click Conversions
AnyAny
post_click_revenue
Post-Click Revenue
AnyAny
post_click_revenue_usd
AnyAny
post_click_total_spend_roi
Post-Click Total Spend ROI
AnyAny
post_view_aov
Post-View AOV
AnyAny
post_view_conversions
Post-View Conversions
AnyAny
post_view_conversions_raw
Post-View Conversions (Raw)
AnyAny
post_view_revenue
Post-View Revenue
AnyAny
post_view_revenue_raw
Post-View Revenue (Raw)
AnyAny
post_view_revenue_raw_usd
AnyAny
post_view_total_spend_roi
Post-View Total Spend ROI
AnyAny
revenue
Revenue (Raw)
AnyAny
rr_per_1k_imps
Response Rate/1K Imps
AnyAny
total_aov
Total AOV
AnyAny
total_conversions
AnyAny
total_revenue
AnyAny
total_spend
AnyAny
total_spend_cpa
Total Spend eCPA
AnyAny
total_spend_cpc
Total Spend eCPC
AnyAny
total_spend_cpcv
Total Spend eCPCV
AnyAny
total_spend_cpm
Total Spend eCPM
AnyAny
total_spend_pc_cpa
Total Spend PC CPA
AnyAny
total_spend_pv_cpa
Total Spend PV CPA
AnyAny
total_spend_roi
Total Spend ROI
AnyAny
total_spend_usd
AnyAny
total_spend_vcpm
Total Spend vCPM
AnyAny
tpa_conversions
3PA Total Conversions
AnyAny
tpa_total_aov
3PA Total AOV
AnyAny
tpa_total_aov_usd
(USD) 3PA Total AOV
AnyAny
tpa_total_revenue
3PA Total Revenue
AnyAny
tpa_total_revenue_usd
(USD) 3PA Total Revenue
AnyAny
tpa_total_spend_cpa
3PA Total Spend CPA
AnyAny
tpa_total_spend_cpa_usd
(USD) 3PA Total Spend CPA
AnyAny
tpa_total_spend_roi
3PA Total Spend ROI
AnyAny
video_close
Close
AnyAny
video_collapse
Collapse
AnyAny
video_companion_clicks
Companion Clicks
AnyAny
video_companion_ctr
Companion CTR
AnyAny
video_companion_impressions
Companion Impressions
AnyAny
video_complete
100% Completed Views
AnyAny
video_complete_rate
100% Completed Rate
AnyAny
video_complete_rate_impression_based
VCR (Impression Based)
AnyAny
video_engaged_impressions
Engaged Impressions
AnyAny
video_engaged_rate
Engaged Rate
AnyAny
video_expand
Expand
AnyAny
video_first_quartile
25% Completed Views
AnyAny
video_first_quartile_rate
25% Completed Rate
AnyAny
video_first_quartile_rate_impression_based
25% Completed Rate - Impressions Based
AnyAny
video_fullscreen
Fullscreen
AnyAny
video_midpoint
50% Completed Views
AnyAny
video_midpoint_rate
50% Completed Rate
AnyAny
video_midpoint_rate_impression_based
50% Completed Rate - Impressions Based
AnyAny
video_mute
AnyAny
video_pause
Pause
AnyAny
video_play_rate
Play Rate
AnyAny
video_resume
Resume
AnyAny
video_rewind
Rewind
AnyAny
video_skip
Skip
AnyAny
video_skippable_impressions
Skippable Impressions
AnyAny
video_skipped_impressions
Skipped Impressions
AnyAny
video_skipped_rate
Skipped Rate
AnyAny
video_start
Start
AnyAny
video_third_quartile
75% Completed Views
AnyAny
video_third_quartile_rate
75% Completed Rate
AnyAny
video_third_quartile_rate_impression_based
75% Completed Rate - Impressions Based
AnyAny
video_unmute
AnyAny
viewability_rate
Viewability Rate
AnyAny
viewability_rate_100_percent
100% In View Rate
AnyAny

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

Bodyapplication/jsonrequired
One of:
end_timestring or null(date-time)
fieldsArray of stringsnon-emptyuniquerequired
filtersArray of objectsnon-emptyrequired
filters[].​fieldstring
filters[].​filtersArray of objects or null>= 2 items
filters[].​opstring
  • =: Equals or contains if value 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 match
  • or: At least one filter must match
Default "="
filters[].​value(integer or number or string or boolean) or boolean or (Array of integers or numbers or strings or booleans)
One of:
One of:
integer
full_entitiesArray of strings or nullnon-emptyunique
orderArray of objectsnon-emptyrequired
order[].​descboolean
Default false
order[].​fieldstringrequired
order[].​nulls_lastboolean
Default false
rollupstringrequired
start_timestring(date-time)
time_windowstringrequired
time_zonestring

Only in supported datasets: campaign, UTC or a time zone name defined in https://www.iana.org/time-zones

curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/reporting-api/openapi/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"
  }'

Responses

JSON for Paginated, JSONL for Streaming

Bodyapplication/jsonl
string(Streaming Response)

Documentation available at https://apidocs.mediamath.com/docs/reporting-api-v2

Response
application/jsonl
"{\"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\"}"

Pixel Loads

Request

Loads and Uniques metrics for data and event pixels, broken out by referrer and referrer rank, available by day.

Fields

FieldTime WindowsRollups
Dimensions
agg_timestampcurrent_day, last_X_days, month_to_date, yesterdayby_day, by_month, by_week
advertiser_name
AnyAny
agency_id
AnyAny
agency_name
AnyAny
organization_id
AnyAny
pixel_advertiser_id
AnyAny
pixel_cost_cpm
AnyAny
pixel_cost_cpts
AnyAny
pixel_cost_pct_cpm
AnyAny
pixel_created_on
Pixel Creation Time
AnyAny
pixel_currency
AnyAny
pixel_currency_fixed
AnyAny
pixel_eligible
AnyAny
pixel_external_identifier
AnyAny
pixel_id
AnyAny
pixel_name
AnyAny
pixel_pricing
AnyAny
pixel_provider_created_on
AnyAny
pixel_provider_execution_by
AnyAny
pixel_provider_id
AnyAny
pixel_provider_name
AnyAny
pixel_provider_provider_tax
AnyAny
pixel_provider_status
AnyAny
pixel_provider_taxonomy_file
AnyAny
pixel_provider_updated_on
AnyAny
pixel_provider_vendor_id
AnyAny
pixel_provider_version
AnyAny
pixel_rmx_conversion_minutes
AnyAny
pixel_rmx_conversion_type
AnyAny
pixel_rmx_friendly
AnyAny
pixel_rmx_merit
AnyAny
pixel_rmx_pc_window_minutes
AnyAny
pixel_rmx_pv_window_minutes
AnyAny
pixel_segment_op
AnyAny
pixel_status
AnyAny
pixel_tag_type
AnyAny
pixel_tags
AnyAny
pixel_type
AnyAny
pixel_updated_on
Pixel Update Time
AnyAny
provider_id
AnyAny
referrer
AnyAny
referrer_rank
AnyAny
Metrics
loads
AnyAny
uniques
AnyAny

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

Bodyapplication/jsonrequired
One of:
end_timestring or null(date-time)
fieldsArray of stringsnon-emptyuniquerequired
filtersArray of objectsnon-emptyrequired
filters[].​fieldstring
filters[].​filtersArray of objects or null>= 2 items
filters[].​opstring
  • =: Equals or contains if value 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 match
  • or: At least one filter must match
Default "="
filters[].​value(integer or number or string or boolean) or boolean or (Array of integers or numbers or strings or booleans)
One of:
One of:
integer
full_entitiesArray of strings or nullnon-emptyunique
orderArray of objectsnon-emptyrequired
order[].​descboolean
Default false
order[].​fieldstringrequired
order[].​nulls_lastboolean
Default false
paginationobject or null

Streaming response if absent or null, Paginated response otherwise

rollupstringrequired
start_timestring(date-time)
time_windowstringrequired
time_zonestring

Only in supported datasets: campaign, UTC or a time zone name defined in https://www.iana.org/time-zones

curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/reporting-api/openapi/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"
  }'

Responses

JSON for Paginated, JSONL for Streaming

Body
metaobject
resultsArray of objects
Response
{ "meta": { "items_count": 0, "page_index": 0, "status": "ok", "total_items_count": 0, "total_pages": 0 }, "results": [ {} ] }

Postal Code Report

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

FieldTime WindowsRollups
Dimensions
agg_timestampcurrent_day, last_X_days, month_to_date, yesterdayby_day, by_month, by_week
advertiser_id
AnyAny
advertiser_name
AnyAny
agency_id
AnyAny
agency_name
AnyAny
attribution_group
AnyAny
campaign_ads_txt_verified
AnyAny
campaign_agency_fee_pct
AnyAny
campaign_archived
AnyAny
campaign_bid_min_devices
AnyAny
campaign_brain_intraday_pacing
AnyAny
campaign_connected_id_type
AnyAny
campaign_conversion_type
AnyAny
campaign_conversion_variable_minutes
AnyAny
campaign_cost_passthrough_cpm_enabled
AnyAny
campaign_cost_passthrough_cpm_value
AnyAny
campaign_cost_passthrough_percent_enabled
AnyAny
campaign_cost_passthrough_percent_value
AnyAny
campaign_created_on
Campaign Creation Time
AnyAny
campaign_currency_code
Campaign Currency Code
AnyAny
campaign_custom_attribution_source
AnyAny
campaign_dcs_data_is_campaign_level
AnyAny
campaign_device_graph_only
AnyAny
campaign_dynamic_budget_allocation_applied
AnyAny
campaign_dynamic_budget_allocation_available
AnyAny
campaign_dynamic_budget_allocation_type
AnyAny
campaign_end_date
(GMT) Campaign End Date
AnyAny
campaign_end_date_tz
(CTZ) Campaign End Date
AnyAny
campaign_frequency_amount
Campaign Frequency Amount
AnyAny
campaign_frequency_interval
Campaign Frequency Interval
AnyAny
campaign_frequency_optimization
Campaign Frequency Optimization
AnyAny
campaign_frequency_type
Campaign Frequency Type
AnyAny
campaign_goal_alert
AnyAny
campaign_goal_category
AnyAny
campaign_goal_type
AnyAny
campaign_goal_value
AnyAny
campaign_has_custom_attribution
AnyAny
campaign_id
AnyAny
campaign_impression_cap_amount
AnyAny
campaign_impression_cap_automatic
AnyAny
campaign_impression_cap_type
AnyAny
campaign_in_flight
In Flight
AnyAny
campaign_initial_start_date
(GMT) Campaign Initial Start Date
AnyAny
campaign_initial_start_date_tz
(CTZ) Campaign Initial Start Date
AnyAny
campaign_io_name
AnyAny
campaign_io_reference_num
AnyAny
campaign_is_programmatic_guaranteed
Campaign Is Programmatic Guaranteed
AnyAny
campaign_merit_pixel_id
AnyAny
campaign_minimize_multi_ads
Minimize Multi Ads
AnyAny
campaign_name
AnyAny
campaign_override_suspicious_traffic_filter
AnyAny
campaign_pacing_alert
AnyAny
campaign_pc_window_minutes
AnyAny
campaign_political
AnyAny
campaign_pv_pct
AnyAny
campaign_pv_window_minutes
AnyAny
campaign_restrict_targeting_to_deterministic_id
AnyAny
campaign_restrict_targeting_to_same_device_id
AnyAny
campaign_service_type
Campaign Service Type, a.k.a. Managed Service Flag / managed_service_flag
AnyAny
campaign_source_campaign_id
AnyAny
campaign_spend_cap_amount
AnyAny
campaign_spend_cap_automatic
AnyAny
campaign_spend_cap_daily_cap
AnyAny
campaign_spend_cap_type
AnyAny
campaign_start_date
(GMT) Campaign Start Date
AnyAny
campaign_start_date_tz
(CTZ) Campaign Start Date
AnyAny
campaign_status
Active Status
AnyAny
campaign_suspicious_traffic_filter_level
AnyAny
campaign_total_budget
AnyAny
campaign_total_impression_budget
Campaign Impressions Budget
AnyAny
campaign_updated_on
Campaign Update Time
AnyAny
campaign_version
AnyAny
campaign_zone_name
Campaign Time Zone, a.k.a time_zone
AnyAny
exchange_id
AnyAny
exchange_name
AnyAny
organization_id
AnyAny
organization_name
AnyAny
postal_code
AnyAny
strategy_ads_txt_verified
AnyAny
strategy_archived
AnyAny
strategy_audience_segment_exclude_op
AnyAny
strategy_audience_segment_include_op
AnyAny
strategy_bid_aggressiveness
AnyAny
strategy_bid_min_devices
AnyAny
strategy_bid_price_is_media_only
AnyAny
strategy_budget
AnyAny
strategy_cost_passthrough_cpm_enabled
AnyAny
strategy_cost_passthrough_cpm_value
AnyAny
strategy_cost_passthrough_percent_enabled
AnyAny
strategy_cost_passthrough_percent_value
AnyAny
strategy_created_on
AnyAny
strategy_currency_code
AnyAny
strategy_description
AnyAny
strategy_device_graph_only
AnyAny
strategy_end_date_raw
AnyAny
strategy_exchange_type_for_run_on_all
AnyAny
strategy_feature_compatibility
AnyAny
strategy_frequency_amount
AnyAny
strategy_frequency_interval
Campaign Frequency Interval
AnyAny
strategy_frequency_optimization
AnyAny
strategy_frequency_type
Campaign Frequency Type
AnyAny
strategy_goal_type
AnyAny
strategy_goal_value
AnyAny
strategy_groups
AnyAny
strategy_id
AnyAny
strategy_impression_pacing_amount
AnyAny
strategy_impression_pacing_interval
AnyAny
strategy_impression_pacing_type
AnyAny
strategy_max_bid
AnyAny
strategy_max_bid_wm
AnyAny
strategy_media_type
AnyAny
strategy_min_bid
AnyAny
strategy_name
AnyAny
strategy_pacing_amount
AnyAny
strategy_pacing_interval
AnyAny
strategy_pacing_optimization_amount
AnyAny
strategy_pacing_optimization_type
AnyAny
strategy_pacing_type
AnyAny
strategy_roi_target
AnyAny
strategy_run_on_all_exchanges
AnyAny
strategy_run_on_all_pmp
AnyAny
strategy_run_on_display
AnyAny
strategy_run_on_mobile
AnyAny
strategy_run_on_only_fraud_filtered_exchanges
AnyAny
strategy_run_on_streaming
AnyAny
strategy_site_restriction_transparent_urls
AnyAny
strategy_site_selectiveness
AnyAny
strategy_source_only
AnyAny
strategy_start_date_raw
AnyAny
strategy_status
Active Status
AnyAny
strategy_supply_type
AnyAny
strategy_targeting_segment_exclude_op
AnyAny
strategy_targeting_segment_include_op
AnyAny
strategy_type
AnyAny
strategy_updated_on
AnyAny
strategy_use_bid_shading
AnyAny
strategy_use_campaign_end
AnyAny
strategy_use_campaign_start
AnyAny
strategy_use_dba_strategy_pacing
AnyAny
strategy_use_dba_strategy_pacing_after_date
AnyAny
strategy_use_mm_freq
AnyAny
strategy_use_optimization
AnyAny
strategy_version
AnyAny
strategy_zone_name
AnyAny
Metrics
clicks
AnyAny
ctc
CTC
AnyAny
ctr
CTR
AnyAny
impressions
AnyAny
post_click_conversions
Post-Click Conversions
AnyAny
post_view_conversions
Post-View Conversions
AnyAny
rr_per_1k_imps
Response Rate/1K Imps
AnyAny
total_conversions
AnyAny
total_spend
AnyAny
total_spend_cpa
Total Spend eCPA
AnyAny
total_spend_cpc
Total Spend eCPC
AnyAny
total_spend_cpm
Total Spend eCPM
AnyAny
total_spend_pc_cpa
Total Spend PC CPA
AnyAny
total_spend_pv_cpa
Total Spend PV CPA
AnyAny

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

Bodyapplication/jsonrequired
One of:
end_timestring or null(date-time)
fieldsArray of stringsnon-emptyuniquerequired
filtersArray of objectsnon-emptyrequired
filters[].​fieldstring
filters[].​filtersArray of objects or null>= 2 items
filters[].​opstring
  • =: Equals or contains if value 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 match
  • or: At least one filter must match
Default "="
filters[].​value(integer or number or string or boolean) or boolean or (Array of integers or numbers or strings or booleans)
One of:
One of:
integer
full_entitiesArray of strings or nullnon-emptyunique
orderArray of objectsnon-emptyrequired
order[].​descboolean
Default false
order[].​fieldstringrequired
order[].​nulls_lastboolean
Default false
rollupstringrequired
start_timestring(date-time)
time_windowstringrequired
time_zonestring

Only in supported datasets: campaign, UTC or a time zone name defined in https://www.iana.org/time-zones

curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/reporting-api/openapi/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"
  }'

Responses

JSON for Paginated, JSONL for Streaming

Bodyapplication/jsonl
string(Streaming Response)

Documentation available at https://apidocs.mediamath.com/docs/reporting-api-v2

Response
application/jsonl
"{\"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\"}"

Reach and Frequency Report

Request

Basic performance metrics as well as the "uniques" metric, broken out by frequency of ad exposure. Available in standard intervals.

Fields

FieldTime WindowsRollups
Dimensions
advertiser_id
AnyAny
advertiser_name
AnyAny
agency_id
AnyAny
agency_name
AnyAny
campaign_ads_txt_verified
AnyAny
campaign_agency_fee_pct
AnyAny
campaign_archived
AnyAny
campaign_bid_min_devices
AnyAny
campaign_brain_intraday_pacing
AnyAny
campaign_connected_id_type
AnyAny
campaign_conversion_type
AnyAny
campaign_conversion_variable_minutes
AnyAny
campaign_cost_passthrough_cpm_enabled
AnyAny
campaign_cost_passthrough_cpm_value
AnyAny
campaign_cost_passthrough_percent_enabled
AnyAny
campaign_cost_passthrough_percent_value
AnyAny
campaign_created_on
Campaign Creation Time
AnyAny
campaign_currency_code
Campaign Currency Code
AnyAny
campaign_custom_attribution_source
AnyAny
campaign_dcs_data_is_campaign_level
AnyAny
campaign_device_graph_only
AnyAny
campaign_dynamic_budget_allocation_applied
AnyAny
campaign_dynamic_budget_allocation_available
AnyAny
campaign_dynamic_budget_allocation_type
AnyAny
campaign_end_date
(GMT) Campaign End Date
AnyAny
campaign_end_date_tz
(CTZ) Campaign End Date
AnyAny
campaign_frequency_amount
Campaign Frequency Amount
AnyAny
campaign_frequency_interval
Campaign Frequency Interval
AnyAny
campaign_frequency_optimization
Campaign Frequency Optimization
AnyAny
campaign_frequency_type
Campaign Frequency Type
AnyAny
campaign_goal_alert
AnyAny
campaign_goal_category
AnyAny
campaign_goal_type
AnyAny
campaign_goal_value
AnyAny
campaign_has_custom_attribution
AnyAny
campaign_id
AnyAny
campaign_impression_cap_amount
AnyAny
campaign_impression_cap_automatic
AnyAny
campaign_impression_cap_type
AnyAny
campaign_in_flight
In Flight
AnyAny
campaign_initial_start_date
(GMT) Campaign Initial Start Date
AnyAny
campaign_initial_start_date_tz
(CTZ) Campaign Initial Start Date
AnyAny
campaign_io_name
AnyAny
campaign_io_reference_num
AnyAny
campaign_is_programmatic_guaranteed
Campaign Is Programmatic Guaranteed
AnyAny
campaign_merit_pixel_id
AnyAny
campaign_minimize_multi_ads
Minimize Multi Ads
AnyAny
campaign_name
AnyAny
campaign_override_suspicious_traffic_filter
AnyAny
campaign_pacing_alert
AnyAny
campaign_pc_window_minutes
AnyAny
campaign_political
AnyAny
campaign_pv_pct
AnyAny
campaign_pv_window_minutes
AnyAny
campaign_restrict_targeting_to_deterministic_id
AnyAny
campaign_restrict_targeting_to_same_device_id
AnyAny
campaign_service_type
Campaign Service Type, a.k.a. Managed Service Flag / managed_service_flag
AnyAny
campaign_source_campaign_id
AnyAny
campaign_spend_cap_amount
AnyAny
campaign_spend_cap_automatic
AnyAny
campaign_spend_cap_daily_cap
AnyAny
campaign_spend_cap_type
AnyAny
campaign_start_date
(GMT) Campaign Start Date
AnyAny
campaign_start_date_tz
(CTZ) Campaign Start Date
AnyAny
campaign_status
Active Status
AnyAny
campaign_suspicious_traffic_filter_level
AnyAny
campaign_total_budget
AnyAny
campaign_total_impression_budget
Campaign Impressions Budget
AnyAny
campaign_updated_on
Campaign Update Time
AnyAny
campaign_version
AnyAny
campaign_zone_name
Campaign Time Zone, a.k.a time_zone
AnyAny
frequency
number of impressions seen by a unique user
AnyAny
frequency_bin
AnyAny
organization_id
AnyAny
organization_name
AnyAny
strategy_ads_txt_verified
AnyAny
strategy_archived
AnyAny
strategy_audience_segment_exclude_op
AnyAny
strategy_audience_segment_include_op
AnyAny
strategy_bid_aggressiveness
AnyAny
strategy_bid_min_devices
AnyAny
strategy_bid_price_is_media_only
AnyAny
strategy_budget
AnyAny
strategy_cost_passthrough_cpm_enabled
AnyAny
strategy_cost_passthrough_cpm_value
AnyAny
strategy_cost_passthrough_percent_enabled
AnyAny
strategy_cost_passthrough_percent_value
AnyAny
strategy_created_on
AnyAny
strategy_currency_code
AnyAny
strategy_description
AnyAny
strategy_device_graph_only
AnyAny
strategy_end_date_raw
AnyAny
strategy_exchange_type_for_run_on_all
AnyAny
strategy_feature_compatibility
AnyAny
strategy_frequency_amount
AnyAny
strategy_frequency_interval
Campaign Frequency Interval
AnyAny
strategy_frequency_optimization
AnyAny
strategy_frequency_type
Campaign Frequency Type
AnyAny
strategy_goal_type
AnyAny
strategy_goal_value
AnyAny
strategy_groups
AnyAny
strategy_id
AnyAny
strategy_impression_pacing_amount
AnyAny
strategy_impression_pacing_interval
AnyAny
strategy_impression_pacing_type
AnyAny
strategy_max_bid
AnyAny
strategy_max_bid_wm
AnyAny
strategy_media_type
AnyAny
strategy_min_bid
AnyAny
strategy_name
AnyAny
strategy_pacing_amount
AnyAny
strategy_pacing_interval
AnyAny
strategy_pacing_optimization_amount
AnyAny
strategy_pacing_optimization_type
AnyAny
strategy_pacing_type
AnyAny
strategy_roi_target
AnyAny
strategy_run_on_all_exchanges
AnyAny
strategy_run_on_all_pmp
AnyAny
strategy_run_on_display
AnyAny
strategy_run_on_mobile
AnyAny
strategy_run_on_only_fraud_filtered_exchanges
AnyAny
strategy_run_on_streaming
AnyAny
strategy_site_restriction_transparent_urls
AnyAny
strategy_site_selectiveness
AnyAny
strategy_source_only
AnyAny
strategy_start_date_raw
AnyAny
strategy_status
Active Status
AnyAny
strategy_supply_type
AnyAny
strategy_targeting_segment_exclude_op
AnyAny
strategy_targeting_segment_include_op
AnyAny
strategy_type
AnyAny
strategy_updated_on
AnyAny
strategy_use_bid_shading
AnyAny
strategy_use_campaign_end
AnyAny
strategy_use_campaign_start
AnyAny
strategy_use_dba_strategy_pacing
AnyAny
strategy_use_dba_strategy_pacing_after_date
AnyAny
strategy_use_mm_freq
AnyAny
strategy_use_optimization
AnyAny
strategy_version
AnyAny
strategy_zone_name
AnyAny
Metrics
clicks
AnyAny
ctc
CTC
AnyAny
ctr
CTR
AnyAny
impressions
AnyAny
post_click_conversions
Post-Click Conversions
AnyAny
post_view_conversions
Post-View Conversions
AnyAny
rr_per_1k_imps
Response Rate/1K Imps
AnyAny
total_conversions
AnyAny
uniques
AnyAny

Pageable

Yes

Time Windows

last_14_days, last_30_days, last_7_days, yesterday

Rollups

all

Bodyapplication/jsonrequired
fieldsArray of stringsnon-emptyuniquerequired
filtersArray of objectsnon-emptyrequired
filters[].​fieldstring
filters[].​filtersArray of objects or null>= 2 items
filters[].​opstring
  • =: Equals or contains if value 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 match
  • or: At least one filter must match
Default "="
filters[].​value(integer or number or string or boolean) or boolean or (Array of integers or numbers or strings or booleans)
One of:
One of:
integer
full_entitiesArray of strings or nullnon-emptyunique
orderArray of objectsnon-emptyrequired
order[].​descboolean
Default false
order[].​fieldstringrequired
order[].​nulls_lastboolean
Default false
paginationobject or null

Streaming response if absent or null, Paginated response otherwise

rollupstringrequired
time_windowstringrequired
time_zonestring

Only in supported datasets: campaign, UTC or a time zone name defined in https://www.iana.org/time-zones

curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/reporting-api/openapi/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"
  }'

Responses

JSON for Paginated, JSONL for Streaming

Body
metaobject
resultsArray of objects
Response
{ "meta": { "items_count": 0, "page_index": 0, "status": "ok", "total_items_count": 0, "total_pages": 0 }, "results": [ {} ] }

Win/Loss

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

FieldTime WindowsRollups
Dimensions
agg_timestampcurrent_day, last_X_days, last_X_hours, month_to_date, yesterdayby_day, by_hour, by_month, by_week
advertiser_id
AnyAny
advertiser_name
AnyAny
agency_id
AnyAny
agency_name
AnyAny
attribution_group
AnyAny
campaign_ads_txt_verified
AnyAny
campaign_agency_fee_pct
AnyAny
campaign_archived
AnyAny
campaign_bid_min_devices
AnyAny
campaign_brain_intraday_pacing
AnyAny
campaign_connected_id_type
AnyAny
campaign_conversion_type
AnyAny
campaign_conversion_variable_minutes
AnyAny
campaign_cost_passthrough_cpm_enabled
AnyAny
campaign_cost_passthrough_cpm_value
AnyAny
campaign_cost_passthrough_percent_enabled
AnyAny
campaign_cost_passthrough_percent_value
AnyAny
campaign_created_on
Campaign Creation Time
AnyAny
campaign_currency_code
Campaign Currency Code
AnyAny
campaign_custom_attribution_source
AnyAny
campaign_dcs_data_is_campaign_level
AnyAny
campaign_device_graph_only
AnyAny
campaign_dynamic_budget_allocation_applied
AnyAny
campaign_dynamic_budget_allocation_available
AnyAny
campaign_dynamic_budget_allocation_type
AnyAny
campaign_end_date
(GMT) Campaign End Date
AnyAny
campaign_end_date_tz
(CTZ) Campaign End Date
AnyAny
campaign_frequency_amount
Campaign Frequency Amount
AnyAny
campaign_frequency_interval
Campaign Frequency Interval
AnyAny
campaign_frequency_optimization
Campaign Frequency Optimization
AnyAny
campaign_frequency_type
Campaign Frequency Type
AnyAny
campaign_goal_alert
AnyAny
campaign_goal_category
AnyAny
campaign_goal_type
AnyAny
campaign_goal_value
AnyAny
campaign_has_custom_attribution
AnyAny
campaign_id
AnyAny
campaign_impression_cap_amount
AnyAny
campaign_impression_cap_automatic
AnyAny
campaign_impression_cap_type
AnyAny
campaign_in_flight
In Flight
AnyAny
campaign_initial_start_date
(GMT) Campaign Initial Start Date
AnyAny
campaign_initial_start_date_tz
(CTZ) Campaign Initial Start Date
AnyAny
campaign_io_name
AnyAny
campaign_io_reference_num
AnyAny
campaign_is_programmatic_guaranteed
Campaign Is Programmatic Guaranteed
AnyAny
campaign_merit_pixel_id
AnyAny
campaign_minimize_multi_ads
Minimize Multi Ads
AnyAny
campaign_name
AnyAny
campaign_override_suspicious_traffic_filter
AnyAny
campaign_pacing_alert
AnyAny
campaign_pc_window_minutes
AnyAny
campaign_political
AnyAny
campaign_pv_pct
AnyAny
campaign_pv_window_minutes
AnyAny
campaign_restrict_targeting_to_deterministic_id
AnyAny
campaign_restrict_targeting_to_same_device_id
AnyAny
campaign_service_type
Campaign Service Type, a.k.a. Managed Service Flag / managed_service_flag
AnyAny
campaign_source_campaign_id
AnyAny
campaign_spend_cap_amount
AnyAny
campaign_spend_cap_automatic
AnyAny
campaign_spend_cap_daily_cap
AnyAny
campaign_spend_cap_type
AnyAny
campaign_start_date
(GMT) Campaign Start Date
AnyAny
campaign_start_date_tz
(CTZ) Campaign Start Date
AnyAny
campaign_status
Active Status
AnyAny
campaign_suspicious_traffic_filter_level
AnyAny
campaign_total_budget
AnyAny
campaign_total_impression_budget
Campaign Impressions Budget
AnyAny
campaign_updated_on
Campaign Update Time
AnyAny
campaign_version
AnyAny
campaign_zone_name
Campaign Time Zone, a.k.a time_zone
AnyAny
deal_exchange_id
AnyAny
deal_external_id
AnyAny
deal_group_id
AnyAny
deal_group_name
AnyAny
deal_id
AnyAny
deal_name
AnyAny
deal_organization_id
AnyAny
deal_price_type
AnyAny
deal_publisher_id
Deal Publisher ID
AnyAny
exchange_id
AnyAny
exchange_name
AnyAny
organization_id
AnyAny
organization_name
AnyAny
strategy_ads_txt_verified
AnyAny
strategy_archived
AnyAny
strategy_audience_segment_exclude_op
AnyAny
strategy_audience_segment_include_op
AnyAny
strategy_bid_aggressiveness
AnyAny
strategy_bid_min_devices
AnyAny
strategy_bid_price_is_media_only
AnyAny
strategy_budget
AnyAny
strategy_cost_passthrough_cpm_enabled
AnyAny
strategy_cost_passthrough_cpm_value
AnyAny
strategy_cost_passthrough_percent_enabled
AnyAny
strategy_cost_passthrough_percent_value
AnyAny
strategy_created_on
AnyAny
strategy_currency_code
AnyAny
strategy_description
AnyAny
strategy_device_graph_only
AnyAny
strategy_end_date_raw
AnyAny
strategy_exchange_type_for_run_on_all
AnyAny
strategy_feature_compatibility
AnyAny
strategy_frequency_amount
AnyAny
strategy_frequency_interval
Campaign Frequency Interval
AnyAny
strategy_frequency_optimization
AnyAny
strategy_frequency_type
Campaign Frequency Type
AnyAny
strategy_goal_type
AnyAny
strategy_goal_value
AnyAny
strategy_groups
AnyAny
strategy_id
AnyAny
strategy_impression_pacing_amount
AnyAny
strategy_impression_pacing_interval
AnyAny
strategy_impression_pacing_type
AnyAny
strategy_max_bid
AnyAny
strategy_max_bid_wm
AnyAny
strategy_media_type
AnyAny
strategy_min_bid
AnyAny
strategy_name
AnyAny
strategy_pacing_amount
AnyAny
strategy_pacing_interval
AnyAny
strategy_pacing_optimization_amount
AnyAny
strategy_pacing_optimization_type
AnyAny
strategy_pacing_type
AnyAny
strategy_roi_target
AnyAny
strategy_run_on_all_exchanges
AnyAny
strategy_run_on_all_pmp
AnyAny
strategy_run_on_display
AnyAny
strategy_run_on_mobile
AnyAny
strategy_run_on_only_fraud_filtered_exchanges
AnyAny
strategy_run_on_streaming
AnyAny
strategy_site_restriction_transparent_urls
AnyAny
strategy_site_selectiveness
AnyAny
strategy_source_only
AnyAny
strategy_start_date_raw
AnyAny
strategy_status
Active Status
AnyAny
strategy_supply_type
AnyAny
strategy_targeting_segment_exclude_op
AnyAny
strategy_targeting_segment_include_op
AnyAny
strategy_type
AnyAny
strategy_updated_on
AnyAny
strategy_use_bid_shading
AnyAny
strategy_use_campaign_end
AnyAny
strategy_use_campaign_start
AnyAny
strategy_use_dba_strategy_pacing
AnyAny
strategy_use_dba_strategy_pacing_after_date
AnyAny
strategy_use_mm_freq
AnyAny
strategy_use_optimization
AnyAny
strategy_version
AnyAny
strategy_zone_name
AnyAny
Metrics
average_bid_amount_cpm
AnyAny
average_win_amount_cpm
AnyAny
bid_rate
AnyAny
bids
AnyAny
matched_bid_opportunities
AnyAny
max_bid_amount_cpm
AnyAny
max_win_amount_cpm
AnyAny
min_bid_amount_cpm
AnyAny
min_win_amount_cpm
AnyAny
pacing_matched_bid_opportunities
AnyAny
total_bid_amount_cpm
AnyAny
total_win_amount_cpm
AnyAny
win_rate
AnyAny
wins
AnyAny

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

Bodyapplication/jsonrequired
One of:
end_timestring or null(date-time)
fieldsArray of stringsnon-emptyuniquerequired
filtersArray of objectsnon-emptyrequired
filters[].​fieldstring
filters[].​filtersArray of objects or null>= 2 items
filters[].​opstring
  • =: Equals or contains if value 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 match
  • or: At least one filter must match
Default "="
filters[].​value(integer or number or string or boolean) or boolean or (Array of integers or numbers or strings or booleans)
One of:
One of:
integer
full_entitiesArray of strings or nullnon-emptyunique
orderArray of objectsnon-emptyrequired
order[].​descboolean
Default false
order[].​fieldstringrequired
order[].​nulls_lastboolean
Default false
rollupstringrequired
start_timestring(date-time)
time_windowstringrequired
time_zonestring

Only in supported datasets: campaign, UTC or a time zone name defined in https://www.iana.org/time-zones

curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/reporting-api/openapi/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"
  }'

Responses

JSON for Paginated, JSONL for Streaming

Bodyapplication/jsonl
string(Streaming Response)

Documentation available at https://apidocs.mediamath.com/docs/reporting-api-v2

Response
application/jsonl
"{\"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\"}"