Rank Tracker Locations
const url = 'https://sitechecker.pro/api/v1/rank_tracker_locations?country_code=US&search=new%20york&limit=50&offset=0';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://sitechecker.pro/api/v1/rank_tracker_locations?country_code=US&search=new%20york&limit=50&offset=0' \ --header 'Authorization: Bearer <token>'Searches the Google locations (cities, regions, …) of one country. When adding keywords, send either location_name or location_id as geo location; omit location to track the whole country. Locations are available for Google only.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Example
USISO 3166-1 alpha-2 country code from rank_tracker_countries.
Example
new yorkCase-insensitive substring of the location name or full location name.
Page size.
Pagination offset.
Responses
Section titled “Responses”Locations ordered by full name
object
A Google location (city, region, DMA, …) inside a country. Either location_name or location_id can be sent as geo location when adding keywords.
object
Opaque location id.
Full canonical location name.
Short location name.
Google target type.
object
Number of items matching the request filters across all pages.
Page size that was applied.
Pagination offset that was applied.
Example
{ "data": [ { "location_id": "loc_TmV3IFlvcmssTmV3IFlvcmssVW5pdGVkIFN0YXRlcw", "location_name": "New York,New York,United States", "name": "New York", "type": "City" } ], "meta": { "total": 137, "limit": 50, "offset": 0 }}Missing or invalid API key
Returned as INVALID_API_KEY when the key is missing or unknown, and as REVOKED_API_KEY when the key exists but was revoked — the latter needs a new key.
object
object
Example
{ "error": { "code": "INVALID_API_KEY", "message": "Invalid or missing API key." }}No active API entitlement for the account
For endpoints that take no project_id. Returned as MISSING_PUBLIC_API_ACCESS when the account has no active API entitlement, and as ACCOUNT_BLOCKED or ACCOUNT_INACTIVE when the account behind a valid key is blocked or deactivated — a new key will not help, contact support@sitechecker.pro.
object
object
Example
{ "error": { "code": "MISSING_PUBLIC_API_ACCESS", "message": "API access is not available: the account has no active API entitlement." }}Validation error, e.g. an unknown country_code
Rejected query parameters. error.code is VALIDATION_ERROR for parameter validation (including a query parameter the endpoint does not accept), or INVALID_DATE_RANGE / INVALID_FILTER / INVALID_EVENT_TYPE / UNSUPPORTED_FILTER / UNSUPPORTED_DIMENSION / UNSUPPORTED_METRIC / UNSUPPORTED_SCOPE / SEGMENT_FILTER_UNSUPPORTED for module-specific rules. Request-body validation errors also carry error.details, listing every invalid field.
object
object
object
Every invalid field, not only the first one repeated in error.message. Present on request-body validation errors; field is the path inside the body.
object
Path of the invalid field inside the request body, e.g. url, keywords[0], geos[1].country_code.
Example
{ "error": { "code": "VALIDATION_ERROR", "message": "project_id is required." }}Rate limit exceeded — retry after the interval in the Retry-After header
object
object
Example
{ "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Rate limit exceeded. Try again later." }}Internal server error
object
object
Example
{ "error": { "code": "INTERNAL_ERROR", "message": "Internal server error." }}