List of Segment Sets
GET {{campaign_url}}/segmentSets?advertiserId={{advertiserId}}&isReusable=true&offset=0&limit=2&sortOrder=desc&sortKey=cost
Retrieve a list of segment sets
You can retrieve all of the segment sets within a specified market or advertiser 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 | Limits response results to segment sets within the market specified. |
Cannot be defined when advertiserId is defined. |
| advertiserId
| string | | Limits response results to segment sets under the advertiser specified. If left unchecked/empty, segment sets under all advertisers are returned.
Cannot be defined when marketId is defined. |
| isReusable
| boolean | | Identifies whether or not response results should be reusable.
Allowed values: true, false |
| offset
| number | | The starting index in the list of segment sets. |
| limit
| number | | The number of segment sets 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, cost |