Projects

Find cities and regions available for monitoring in a market

Searches the locations that can be monitored inside one country, such as states, regions and cities, for the chosen search engines (a location must be supported by every engine selected). Without query it returns the country and the most common locations. With main_cities=true it returns only the market's main cities (United States, United Kingdom and Spain), which fills a project's location list quickly; other markets return none. Pass the returned code and name in locations to create_project or update_project.

get/locations

Request

  • Base URL: https://adslighthouse.com/api/v1
  • URL: https://adslighthouse.com/api/v1/locations
  • Auth: HTTP bearer

Query parameters

countrystring required

ISO 3166-1 alpha-2, such as US.

querystring

Part of a name, such as new york.

'google' | 'bing'
OR
string[]
limitinteger

Locations to return, 1 to 100.

boolean
OR
'true' | 'false'

Response

Find cities and regions available for monitoring in a market

countrystring required
search_enginesstring[] required
total_matchesinteger required
request_idstring

Changes

No recorded changes to this operation across all 1 revision of this API.