get
https://sandbox-api.viantinc.com/{basePath}/deal/getAllDeals
Returns the details for all PMP deals under the account.
Request
GET /deal/getAllDeals
Response
| JSON Fields | Type | Description |
|---|---|---|
| messages | Object Array | An array of any error messages. |
| messages[].level | String | Error level. |
| messages[].code | String | Error code. |
| messages[].message | String | Error message. |
| entity | Object Array | An array of deal objects. |
| entity[].id | Number | The internal Viant deal ID. |
| entity[].advertiserId | Number | The advertiser ID. If null, the deal is accessible to the entire account. |
| entity[].exchangeId | Number | The Viant exchange ID. |
| entity[].dealId | String | The exchange provided deal ID. |
| entity[].name | String | The deal name. |
| entity[].description | String | The deal description. |
Example
Request
curl -u <user>:<password> https://sandbox-api.viant.com/v1/deal/getAllDealResponse
{
"messages": [],
"entity": [
{
"id": 5656,
"advertiserId": 999,
"exchangeId": 3,
"dealId": "XYZ-abc",
"name": "Sports Site",
"description": "Some amazing sports inventory."
},
{
"id": 6565,
"advertiserId": null,
"exchangeId": 4,
"dealId": "8783a",
"name": "Premium Video",
"description": "Great pre-roll."
}
]
}