Получение информации о сайте

Возвращает информацию о сайте.

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

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

user-id

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

host-id

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

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

Пример

{
  "host_id": "https:ya.ru:443",
  "verified": true,
  "ascii_host_url": "https://ya.ru/",
  "unicode_host_url": "https://ya.ru/",
  "main_mirror": {
    "host_id": "http:xn--d1acpjx3f.xn--p1ai:80",
    "ascii_host_url": "http://xn--d1acpjx3f.xn--p1ai/",
    "unicode_host_url": "http://Яндекс рф/",
    "verified": false
  },
  "host_data_status": "NOT_INDEXED",
  "host_display_name": "Ya.ru"
}
<Data>
    <host_id>https:ya.ru:443</host_id>
    <verified>true</verified>
    <ascii_host_url>https://ya.ru/</ascii_host_url>
    <unicode_host_url>https://ya.ru/</unicode_host_url>
    <main_mirror>
        <host_id>http:xn--d1acpjx3f.xn--p1ai:80</host_id>
        <ascii_host_url>http://xn--d1acpjx3f.xn--p1ai/</ascii_host_url>
        <unicode_host_url>http://Яндекс рф/</unicode_host_url>
        <verified>false</verified>
    </main_mirror>
    <host_data_status>NOT_INDEXED</host_data_status>
    <host_display_name>Ya.ru</host_display_name>
</Data>

Имя

Обязательный

Тип

Описание

host_id

Да

host id (string)

ID запрошенного сайта.

ascii_host_url

Да

string

ASCII URL сайта.

unicode_host_url

Да

string

UTF-8 URL сайта.

verified

Да

boolean

Подтвержден ли сайт.

main_mirror

Нет

Главный адрес сайта, если есть.

host_data_status

Нет

string (ApiHostDataStatus)

Информация о сайте (показывается, если сайт подтвержден).

host_display_name

Нет

string

Отображаемое имя сайта.

Статус индексирования сайта (ApiHostDataStatus)

Источник

Описание

NOT_INDEXED

Сайт еще не проиндексирован.

NOT_LOADED

Данные о сайте еще не загружены в Яндекс Вебмастер.

OK

Сайт проиндексирован, данные доступны в Яндекс Вебмастере.

Коды ответа

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

Код

Причина

Описание

200

OK

403

INVALID_USER_ID

ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже {user_id} указан правильный uid владельца OAuth-токена.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
<Data>
    <[error_code](*error_code)>INVALID_USER_ID</error_code>
    <[available_user_id](*available_user_id)>1</available_user_id>
    <[error_message](*error_message)>Invalid user id. {user_id} should be used.</error_message>
</Data>

404

HOST_NOT_FOUND

Сайт отсутствует в списке сайтов пользователя.

{
  "error_code": "HOST_NOT_FOUND",
  "host_id": "http:ya.ru:80",
  "error_message": "explicit error message"
}
<Data>
    <[error_code](*error_code)>HOST_NOT_FOUND</error_code>
    <[host_id](*host_id)>http:ya.ru:80</host_id>
    <[error_message](*error_message)>explicit error message</error_message>
</Data>

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

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

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

Описание

Признак подтверждения сайта.

Статус индексирования сайта (ApiHostDataStatus)

Источник

Описание

NOT_INDEXED

Сайт еще не проиндексирован.

NOT_LOADED

Данные о сайте еще не загружены в Яндекс Вебмастер.

OK

Сайт проиндексирован, данные доступны в Яндекс Вебмастере.

Обязательный

Да

Тип

host id (string)

Описание

ID запрошенного сайта.

Обязательный

Да

Тип

string

Описание

ASCII URL сайта.

Обязательный

Да

Тип

string

Описание

UTF-8 URL сайта.

Обязательный

Да

Тип

boolean

Описание

Подтвержден ли сайт.

Обязательный

Нет

Тип

Описание

Главный адрес сайта, если есть.

Обязательный

Нет

Тип

string (ApiHostDataStatus)

Описание

Информация о сайте (показывается, если сайт подтвержден).

Обязательный

Нет

Тип

string

Описание

Отображаемое имя сайта.