Справочник регионов

Позволяет получить список регионов, по которым доступна выгрузка данных.

Формат запроса

GET /v4/user/{user-id}/hosts/{host-id}/pro/regions
  ? [filter=<string>]
  & [limit=<integer>]

Параметр	Тип	Обязательно	Описание
`user-id`	`int64`	Да	ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.
`host-id`	`host id (string)`	Да	ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user‑id}/hosts.
`filter`	`string`	Нет	Подстрочный фильтр по названию региона. Регистр и язык учитываются так, как в данных источника.
`limit`	`integer`	Нет	Максимальное количество записей в выдаче.

Для запроса необходимо указать два HTTP-заголовка:

Authorization

Authorization: OAuth {ваш_токен}

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/pro/regions?filter=%D0%91%D0%B0%D1%88%D0%BA&limit=123

{
  "regions": [
    {
      "id": 11111,
      "name": "Республика Башкортостан"
    }
  ]
}

Параметр	Тип	Обязательно	Описание
`id`	`integer`	Да	Числовой идентификатор региона.
`name`	`string`	Да	Название региона.

Чтобы посмотреть структуру ответа подробнее, нажмите на причину.

Код	Причина	Описание
200	OK	Успешно.
400	WRONG_REGIONS	Регионы некорректны. `{ "code": "WRONG_REGIONS", "message": "Region ids must be positive" }`
400	EMPTY_PATHS	Пустые пути. `{ "code": "EMPTY_PATHS", "message": "Paths cannot be empty" }`
400	EMPTY_DATES	Пустые даты. `{ "code": "EMPTY_DATES", "message": "Dates cannot be empty" }`
400	SOME_DATES_ARE_UNAVAILABLE	Некоторые даты недоступны (слишком старые или еще не обработаны). `{ "code": "SOME_DATES_ARE_UNAVAILABLE", "message": "Some dates are unavailable. Examples: [2024-01-01, 2024-01-02, 2024-01-03]", "unavailable_dates": ["2024-01-01", "2024-01-03"] }`
400	URLS_ARE_CORRUPTED	Некоторые переданные пути/URL некорректны. `{ "code": "URLS_ARE_CORRUPTED", "message": "Some urls are corrupted or invalid for the specified host" }`
403	LIMITS_EXCEEDED	Превышены лимиты расширенного доступа. `{ "code": "LIMITS_EXCEEDED", "message": "PRO feature limits exceeded" }`
413	PAYLOAD_TOO_LARGE	Превышен размер запроса по количеству дат и URL. `{ "code": "PAYLOAD_TOO_LARGE", "message": "Amount of dates and urls is too large. Limit: 100", "limit": 100 }`