List of Regions

GET {{location_url}}/regions?countryId=1&offset=0&sortOrder=asc

Retrieve a list of regions

You can retrieve all of the regions (e.g., provinces, regions) available for geo targeting by sending this GET request.

The region ids returned in the response body can be used to define fields within the following Campaign Service requests:

• POST New LI - geography (DTO)

Request Params

Value can be retrieved from GET List of Countries. | | offset | number | | The starting index in the list of regions. | | limit | number | | The number of regions to return. | | sortOrder | string | | Direction of result sorting (by name).

Allowed values: asc, desc |

RESPONSES

status: OK

{"totalNum":13,"data":[{"id":"1","resourceType":"region","name":"Alberta","countryId":"1"},{"id":"2","resourceType":"region","name":"British Columbia","countryId":"1"},{"id":"3","resourceType":"region","name":"Manitoba","countryId":"1"},{"id":"4","resourceType":"region","name":"New Brunswick","countryId":"1"},{"id":"5","resourceType":"region","name":"Newfoundland","countryId":"1"},{"id":"12","resourceType":"region","name":"Northwest Territories","countryId":"1"},{"id":"6","resourceType":"region","name":"Nova Scotia","countryId":"1"},{"id":"7","resourceType":"region","name":"Nunavut","countryId":"1"},{"id":"8","resourceType":"region","name":"Ontario","countryId":"1"},{"id":"9","resourceType":"region","name":"Prince Edward Island","countryId":"1"},{"id":"10","resourceType":"region","name":"Quebec","countryId":"1"},{"id":"11","resourceType":"region","name":"Saskatchewan","countryId":"1"},{"id":"13","resourceType":"region","name":"Yukon Territory","countryId":"1"}],"errors":[],"links":{"self":"https://services.amobee.com/location/v1/api/regions?countryId=1\u0026offset=0\u0026sortOrder=asc"}}