List of Location Groups
GET {{campaign_url}}/locationGroups?marketId=1&offset=0&limit=3&sortOrder=desc&sortKey=targetGeoType
Retrieve a list of location groups
You can retrieve all of the location groups 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. | |
offset | number | The starting index in the list of location group objects. | |
limit | number | The number of location groups 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, targetGeoType |