List of Retargeting Segments
GET {{campaign_url}}/retargetingSegments?marketId=1&offset=0&limit=2&sortOrder=asc&sortKey=name
Retrieve a list of retargeting segments
You can retrieve all of the retargeting segments within a specified market or advertiser by sending this GET
request.
Note: marketId
and advertiserId
cannot be used at the same time for a single request.
If you want to view all retargeting segments under a given market and have access to multiple markets, you must specify a value for marketId
.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
marketId | number | Limits response results to retargeting segments within the market specified. |
Cannot be defined when advertiserId is defined. |
| advertiserId
| string | | Limits response results to retargeting segments under the advertiser specified. If left unchecked/empty, retargeting segments under all advertisers are returned.
Cannot be defined when marketId is defined. |
| offset
| number | | The starting index in the list of retargeting segments. |
| limit
| number | | The number of retargeting segments 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: name, advertiserId |