# Win/Loss

Metrics describe the auction before a win or even a bid has taken place.  Broken out by strategy, exchange, and deal dimensions and available by hour.
### Fields
| Field | Time Windows | Rollups |
|  --- | --- | --- |
| **Dimensions** |  |  |
| `agg_timestamp` | `current_day`, `last_X_hours`, `yesterday`, `last_X_days`, `month_to_date` | `by_hour`, `by_day`, `by_week`, `by_month` |
| `advertiser_id` | Any | Any |
| `advertiser_name` | Any | Any |
| `agency_id` | Any | Any |
| `agency_name` | Any | Any |
| `campaign_archived` | Any | Any |
| `campaign_conversion_type` | Any | Any |
| `campaign_conversion_variable_minutes` | Any | Any |
| `campaign_created_on`Campaign Creation Time | Any | Any |
| `campaign_currency_code`Campaign Currency Code | Any | Any |
| `campaign_custom_attribution_source` | Any | Any |
| `campaign_dynamic_budget_allocation_type` | Any | Any |
| `campaign_end_date`(GMT) Campaign End Date | Any | Any |
| `campaign_end_date_campaign_tz`(CTZ) Campaign End Date | Any | Any |
| `campaign_frequency_amount`Campaign Frequency Amount | Any | Any |
| `campaign_frequency_interval`Campaign Frequency Interval | Any | Any |
| `campaign_frequency_optimization`Campaign Frequency Optimization | Any | Any |
| `campaign_frequency_type`Campaign Frequency Type | Any | Any |
| `campaign_goal_type` | Any | Any |
| `campaign_goal_value` | Any | Any |
| `campaign_has_custom_attribution` | Any | Any |
| `campaign_id` | Any | Any |
| `campaign_impression_cap_amount` | Any | Any |
| `campaign_impression_cap_automatic` | Any | Any |
| `campaign_impression_cap_type` | Any | Any |
| `campaign_initial_start_date`(GMT) Campaign Initial Start Date | Any | Any |
| `campaign_initial_start_date_campaign_tz`(CTZ) Campaign Initial Start Date | Any | Any |
| `campaign_io_name` | Any | Any |
| `campaign_io_reference_num` | Any | Any |
| `campaign_is_programmatic_guaranteed`Campaign Is Programmatic Guaranteed | Any | Any |
| `campaign_name` | Any | Any |
| `campaign_pc_window_minutes` | Any | Any |
| `campaign_political` | Any | Any |
| `campaign_pv_pct` | Any | Any |
| `campaign_pv_window_minutes` | Any | Any |
| `campaign_service_type`Campaign Service Type, a.k.a. Managed Service Flag / managed_service_flag | Any | Any |
| `campaign_spend_cap_amount` | Any | Any |
| `campaign_spend_cap_automatic` | Any | Any |
| `campaign_spend_cap_daily_cap` | Any | Any |
| `campaign_spend_cap_type` | Any | Any |
| `campaign_start_date`(GMT) Campaign Start Date | Any | Any |
| `campaign_start_date_campaign_tz`(CTZ) Campaign Start Date | Any | Any |
| `campaign_status`Active Status | Any | Any |
| `campaign_total_budget` | Any | Any |
| `campaign_total_impression_budget`Campaign Impressions Budget | Any | Any |
| `campaign_updated_on`Campaign Update Time | Any | Any |
| `campaign_zone_name`Campaign Time Zone, a.k.a time_zone | Any | Any |
| `deal_external_id` | Any | Any |
| `deal_group_id` | Any | Any |
| `deal_group_name` | Any | Any |
| `deal_id` | Any | Any |
| `deal_name` | Any | Any |
| `deal_price_type` | Any | Any |
| `deal_publisher_id`Deal Publisher ID | Any | Any |
| `exchange_id` | Any | Any |
| `exchange_name` | Any | Any |
| `organization_id` | Any | Any |
| `organization_name` | Any | Any |
| `strategy_archived` | Any | Any |
| `strategy_audience_segment_exclude_op` | Any | Any |
| `strategy_audience_segment_include_op` | Any | Any |
| `strategy_bid_aggressiveness` | Any | Any |
| `strategy_bid_price_is_media_only` | Any | Any |
| `strategy_budget` | Any | Any |
| `strategy_channel` | Any | Any |
| `strategy_created_on` | Any | Any |
| `strategy_description` | Any | Any |
| `strategy_end_date` | Any | Any |
| `strategy_exchange_type_for_run_on_all` | Any | Any |
| `strategy_frequency_amount` | Any | Any |
| `strategy_frequency_interval`Campaign Frequency Interval | Any | Any |
| `strategy_frequency_optimization` | Any | Any |
| `strategy_frequency_type`Campaign Frequency Type | Any | Any |
| `strategy_goal_type` | Any | Any |
| `strategy_goal_value` | Any | Any |
| `strategy_group_created_on` | Any | Any |
| `strategy_group_description` | Any | Any |
| `strategy_group_external_identifier` | Any | Any |
| `strategy_group_id` | Any | Any |
| `strategy_group_impression_cap_amount` | Any | Any |
| `strategy_group_impression_cap_type` | Any | Any |
| `strategy_group_name` | Any | Any |
| `strategy_group_spend_cap_amount` | Any | Any |
| `strategy_group_spend_cap_type` | Any | Any |
| `strategy_group_updated_on` | Any | Any |
| `strategy_groups` | Any | Any |
| `strategy_id` | Any | Any |
| `strategy_impression_pacing_amount` | Any | Any |
| `strategy_impression_pacing_interval` | Any | Any |
| `strategy_impression_pacing_type` | Any | Any |
| `strategy_max_bid` | Any | Any |
| `strategy_max_bid_wm` | Any | Any |
| `strategy_min_bid` | Any | Any |
| `strategy_name` | Any | Any |
| `strategy_pacing_amount` | Any | Any |
| `strategy_pacing_interval` | Any | Any |
| `strategy_pacing_optimization_amount` | Any | Any |
| `strategy_pacing_optimization_type` | Any | Any |
| `strategy_pacing_type` | Any | Any |
| `strategy_roi_target` | Any | Any |
| `strategy_site_restriction_transparent_urls` | Any | Any |
| `strategy_start_date` | Any | Any |
| `strategy_status`Active Status | Any | Any |
| `strategy_targeting_segment_exclude_op` | Any | Any |
| `strategy_targeting_segment_include_op` | Any | Any |
| `strategy_updated_on` | Any | Any |
| `strategy_use_campaign_end` | Any | Any |
| `strategy_use_campaign_start` | Any | Any |
| `strategy_use_mm_freq` | Any | Any |
| `strategy_use_optimization` | Any | Any |
| **Metrics** |  |  |
| `average_bid_amount_cpm` | Any | Any |
| `average_win_amount_cpm` | Any | Any |
| `bid_rate` | Any | Any |
| `bids` | Any | Any |
| `matched_bid_opportunities` | Any | Any |
| `max_bid_amount_cpm` | Any | Any |
| `max_win_amount_cpm` | Any | Any |
| `min_bid_amount_cpm` | Any | Any |
| `min_win_amount_cpm` | Any | Any |
| `pacing_matched_bid_opportunities` | Any | Any |
| `total_bid_amount_cpm` | Any | Any |
| `total_win_amount_cpm` | Any | Any |
| `win_rate` | Any | Any |
| `wins` | Any | Any |

### Pageable
Yes
### Time Windows
`current_day`, `last_X_hours`, `yesterday`, `last_X_days`, `month_to_date`
### Rollups
`all`, `by_hour`, `by_day`, `by_week`, `by_month`
### Data Retention / Lookback Window
1 year

Endpoint: POST /win-loss
Version: 1.0.0
Security: Auth0

## Description:

  - `Fields` ()
    FieldTime WindowsRollupsDimensionsagg_timestampcurrent_day, last_X_hours, yesterday, last_X_days, month_to_dateby_hour, by_day, by_week, by_monthadvertiser_idAnyAnyadvertiser_nameAnyAnyagency_idAnyAnyagency_nameAnyAnycampaign_archivedAnyAnycampaign_conversion_typeAnyAnycampaign_conversion_variable_minutesAnyAnycampaign_created_onCampaign Creation TimeAnyAnycampaign_currency_codeCampaign Currency CodeAnyAnycampaign_custom_attribution_sourceAnyAnycampaign_dynamic_budget_allocation_typeAnyAnycampaign_end_date(GMT) Campaign End DateAnyAnycampaign_end_date_campaign_tz(CTZ) Campaign End DateAnyAnycampaign_frequency_amountCampaign Frequency AmountAnyAnycampaign_frequency_intervalCampaign Frequency IntervalAnyAnycampaign_frequency_optimizationCampaign Frequency OptimizationAnyAnycampaign_frequency_typeCampaign Frequency TypeAnyAnycampaign_goal_typeAnyAnycampaign_goal_valueAnyAnycampaign_has_custom_attributionAnyAnycampaign_idAnyAnycampaign_impression_cap_amountAnyAnycampaign_impression_cap_automaticAnyAnycampaign_impression_cap_typeAnyAnycampaign_initial_start_date(GMT) Campaign Initial Start DateAnyAnycampaign_initial_start_date_campaign_tz(CTZ) Campaign Initial Start DateAnyAnycampaign_io_nameAnyAnycampaign_io_reference_numAnyAnycampaign_is_programmatic_guaranteedCampaign Is Programmatic GuaranteedAnyAnycampaign_nameAnyAnycampaign_pc_window_minutesAnyAnycampaign_politicalAnyAnycampaign_pv_pctAnyAnycampaign_pv_window_minutesAnyAnycampaign_service_typeCampaign Service Type, a.k.a. Managed Service Flag / managed_service_flagAnyAnycampaign_spend_cap_amountAnyAnycampaign_spend_cap_automaticAnyAnycampaign_spend_cap_daily_capAnyAnycampaign_spend_cap_typeAnyAnycampaign_start_date(GMT) Campaign Start DateAnyAnycampaign_start_date_campaign_tz(CTZ) Campaign Start DateAnyAnycampaign_statusActive StatusAnyAnycampaign_total_budgetAnyAnycampaign_total_impression_budgetCampaign Impressions BudgetAnyAnycampaign_updated_onCampaign Update TimeAnyAnycampaign_zone_nameCampaign Time Zone, a.k.a time_zoneAnyAnydeal_external_idAnyAnydeal_group_idAnyAnydeal_group_nameAnyAnydeal_idAnyAnydeal_nameAnyAnydeal_price_typeAnyAnydeal_publisher_idDeal Publisher IDAnyAnyexchange_idAnyAnyexchange_nameAnyAnyorganization_idAnyAnyorganization_nameAnyAnystrategy_archivedAnyAnystrategy_audience_segment_exclude_opAnyAnystrategy_audience_segment_include_opAnyAnystrategy_bid_aggressivenessAnyAnystrategy_bid_price_is_media_onlyAnyAnystrategy_budgetAnyAnystrategy_channelAnyAnystrategy_created_onAnyAnystrategy_descriptionAnyAnystrategy_end_dateAnyAnystrategy_exchange_type_for_run_on_allAnyAnystrategy_frequency_amountAnyAnystrategy_frequency_intervalCampaign Frequency IntervalAnyAnystrategy_frequency_optimizationAnyAnystrategy_frequency_typeCampaign Frequency TypeAnyAnystrategy_goal_typeAnyAnystrategy_goal_valueAnyAnystrategy_group_created_onAnyAnystrategy_group_descriptionAnyAnystrategy_group_external_identifierAnyAnystrategy_group_idAnyAnystrategy_group_impression_cap_amountAnyAnystrategy_group_impression_cap_typeAnyAnystrategy_group_nameAnyAnystrategy_group_spend_cap_amountAnyAnystrategy_group_spend_cap_typeAnyAnystrategy_group_updated_onAnyAnystrategy_groupsAnyAnystrategy_idAnyAnystrategy_impression_pacing_amountAnyAnystrategy_impression_pacing_intervalAnyAnystrategy_impression_pacing_typeAnyAnystrategy_max_bidAnyAnystrategy_max_bid_wmAnyAnystrategy_min_bidAnyAnystrategy_nameAnyAnystrategy_pacing_amountAnyAnystrategy_pacing_intervalAnyAnystrategy_pacing_optimization_amountAnyAnystrategy_pacing_optimization_typeAnyAnystrategy_pacing_typeAnyAnystrategy_roi_targetAnyAnystrategy_site_restriction_transparent_urlsAnyAnystrategy_start_dateAnyAnystrategy_statusActive StatusAnyAnystrategy_targeting_segment_exclude_opAnyAnystrategy_targeting_segment_include_opAnyAnystrategy_updated_onAnyAnystrategy_use_campaign_endAnyAnystrategy_use_campaign_startAnyAnystrategy_use_mm_freqAnyAnystrategy_use_optimizationAnyAnyMetricsaverage_bid_amount_cpmAnyAnyaverage_win_amount_cpmAnyAnybid_rateAnyAnybidsAnyAnymatched_bid_opportunitiesAnyAnymax_bid_amount_cpmAnyAnymax_win_amount_cpmAnyAnymin_bid_amount_cpmAnyAnymin_win_amount_cpmAnyAnypacing_matched_bid_opportunitiesAnyAnytotal_bid_amount_cpmAnyAnytotal_win_amount_cpmAnyAnywin_rateAnyAnywinsAnyAny

  - `Pageable` ()
    Yes

  - `Time Windows` ()
    current_day, last_X_hours, yesterday, last_X_days, month_to_date

  - `Rollups` ()
    all, by_hour, by_day, by_week, by_month

  - `Data Retention / Lookback Window` ()
    1 year

## Security:

  - `Auth0` (unknown)
    oauth2 scopes: offline_access

## Request fields (application/json):

  - `end_time` (string)

  - `fields` (array, required)

  - `filters` (array, required)

  - `filters.field` (string)

  - `filters.filters` (array)

  - `filters.filters.field` (string)

  - `filters.filters.filters` (array)
    An array of filters. Required if `op` is `and` or `or`.

  - `filters.filters.op` (string)
    * `=`: 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
* `isNull`: Is null
* `isNotNull`: Is not null

  - `filters.filters.value` (any)

  - `filters.op` (string)
    * `=`: 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
* `isNull`: Is null
* `isNotNull`: Is not null

  - `filters.value` (any)

  - `full_entities` (array)

  - `max_results` (integer)
    Maximum number of results to return. Only applicable for streaming responses. No limit if absent or `null`.

  - `order` (array)

  - `order.desc` (boolean)

  - `order.field` (string, required)

  - `order.nulls_last` (boolean)

  - `pagination` (object)
    Streaming response if absent or `null`, Paginated response otherwise

  - `pagination.page_index` (integer)

  - `pagination.page_size` (integer)

  - `rollup` (string, required)

  - `start_time` (string)

  - `time_window` (string)

  - `time_zone` (string)
    **Only in supported datasets:** `campaign`, `UTC` or a time zone name defined in https://www.iana.org/time-zones

## Response 200:

  - `200` (unknown)
    JSON for Paginated, JSONL for Streaming

## Response 200 fields (application/json):

  - `meta` (object)

  - `meta.items_count` (integer)

  - `meta.page_index` (integer)

  - `meta.status` (string)
    Enum: "OK"

  - `meta.total_items_count` (integer)

  - `meta.total_pages` (integer)

  - `results` (array)

## Response 400:

  - `400` (unknown)
    The request is not valid

## Response 400 fields (application/json):

  - `error_code` (string)

  - `message` (string)

  - `request_id` (string)

## Response 401:

  - `401` (unknown)
    Unauthorized

## Response 401 fields (application/json):

  - `error_code` (string)

  - `message` (string)

  - `request_id` (string)

## Response 5XX:

  - `5XX` (unknown)
    An error occurred

## Response 5XX fields (application/json):

  - `error_code` (string)

  - `message` (string)

  - `request_id` (string)

