# Deals

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.
**NOTE: this dataset requires the use of filter `organization_id` with exactly 1 value, and `deal_id` with at least 1 value.**
### 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` |
| `deal_external_id`<br> | Any | Any |
| `deal_group_id`<br> | Any | Any |
| `deal_group_name`<br> | Any | Any |
| `deal_id`<br> | Any | Any |
| `deal_name`<br> | Any | Any |
| `deal_price_type`<br> | Any | Any |
| `deal_publisher_id`<br>Deal Publisher ID | Any | Any |
| `exchange_id`<br> | Any | Any |
| `exchange_name`<br> | Any | Any |
| **Metrics** |  |  |
| `bid_rate`<br> | Any | Any |
| `biddables`<br> | Any | Any |
| `bids`<br> | Any | Any |
| `matches`<br> | Any | Any |
| `win_rate`<br> | Any | Any |
| `wins`<br> | 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 /deals
Version: 1.0.0
Security: Auth0

## 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 fields (application/json):

  - `error_code` (string)

  - `message` (string)

  - `request_id` (string)

## Response 401 fields (application/json):

  - `error_code` (string)

  - `message` (string)

  - `request_id` (string)

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

  - `error_code` (string)

  - `message` (string)

  - `request_id` (string)