List of Deals
GET {{campaign_url}}/publisherDeals?marketId=1&showDeleted=false&offset=0&limit=2&sortOrder=asc&sortKey=id
Retrieve a list of publisher deals
You can retrieve all of the publisher deals within your market by sending this GET
request.
Note: If you have access to multiple markets, you must specify a value for marketId
. Otherwise (i.e., marketId
is left unchecked), the request will return a 300 Multiple Choices response containing a list of market IDs that can be passed as marketId
values.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
marketId | number | Numeric ID associated with a given market. Required only if you have access to multiple markets. | |
showDeleted | boolean | Identifies whether or not response results should include deleted publisher deals. |
Allowed values: true, false |
| offset
| number | | The starting index in the list of deal objects. |
| limit
| number | | The number of deals to return. |
| sortOrder
| string | | Direction by which results should be sorted.
Allowed values: asc, desc |
| sortKey
| string | | Field by which results should be sorted.
Allowed values: id, name |