The Deal Sync API supports the following filter parameters.
| Parameter | Description | Type |
|---|---|---|
| seatid | Only returns deals for the specified seat ID | string |
| startdate | Only returns deals with start date ≥ specified start date | datetime (ISO-8601) |
| enddate | Only returns deals with end date date ≤ specified end date | datetime (ISO-8601) |
| updatedat | Only returns deals that have been updated at a specific date | datetime (ISO-8601) |
| sellerstatus | Only returns deals that have specified a particular sellerstatus field:
E.g. api.freewheel.tv/demand/v1/deals?sellerstatus=ACTIVE | string |
| preingestpermissions | Only returns deals that correspond to the four different types of permissions (1, 2, 3, 4). 1 = Required. Represents PG deals. 2 = Allowed. Represents PMP deals that the publisher allows for pre-ingestion. 3 = Not Allowed. Represents all other deals that are not PG or have not been enabled for a buyer to pre-ingest their creatives. 4 = Not Available. Represents all other deals that are not part of the existing MRM prog mod workflow. | integer |
The relationship among these filter parameters is a Logical AND.
Sample URLs with Filter Parameters
| Scenario | Sample URL |
|---|---|
| Filtering based on start and end dates | https://api.freewheel.tv/demand/v1/deals?seatid=example-seat-id-1&startdate=201901-01T00:00:00Z&enddate=2019-01-25T00:00:00Z |
| Filtering on updated deals within a certain time range | https://api.freewheel.tv/demand/v1/deals?updatedat=2018-01-01T00:00:00Z..2019-01-01T00:00:00Z |
| Filtering on deals that were updated after a particular date | https://api.freewheel.tv/demand/v1/deals?updatedat=2019-01-01T00:00:00Z.. |
| Filtering non default pagination values | https://api.freewheel.tv/demand/v1/deals?count=25&offset=0 |