Доступы и лимиты домена

Позволяет проверить лимиты API-запросов по вашему доступу.

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

GET /v4/user/{user-id}/hosts/{host-id}/pro/limits

Параметр

Тип

Обязательно

Описание

user-id

int64

Да

ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.

host-id

host id (string)

Да

ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user‑id}/hosts.

Заголовки запроса

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

  1. Authorization

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

  2. Accept

    Accept: application/json

Пример запроса

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/pro/limits

Формат ответа

Пример

{
  "limits": [
    {
      "owner": "user-123",
      "feature": "PRO_SERP",
      "limit": 1000,
      "used": 250,
      "remaining": 750,
      "period_start": "2025-01-10",
      "period_end": "2025-12-30",
      "is_active": true,
      "tariff_id": "a1b2c3d4-5678-90ef-1234-567890abcdef"
    }
  ]
}

Параметр

Тип

Обязательно

Описание

owner

string

Да

Владелец аккаунта или домена.

feature

string

Да

Вид доступа.

limit

integer

Да

Общее количество доступных запросов.

used

integer

Да

Количество использованных запросов.

remaining

integer

Да

Остаток доступных запросов.

period_start

string

Да

Начало периода действия лимита.

period_end

string

Да

Окончание периода действия лимита.

is_active

boolean

Да

Активен ли расширенный доступ:

  • true — активен;
  • false — не активен.

tariff_id

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
}

Узнайте больше

OAuth-токен для доступа к API.

Указывает, что ответ должен быть в формате JSON.

Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.

Тип: host id (string). ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user‑id}/hosts.

Тип: integer. Максимально допустимый суммарный размер (дат + URL).

Тип: string. Полный список недоступных дат.

Предыдущая
Справочник регионов
Следующая
Доступные даты