summary Сводка: видимость, потенциал и интегральные оценки проекта
Группа отдаёт показатели со «Сводки» проекта: динамику видимости в выдаче, её изменение между двумя апдейтами позиций по каждой поисковой системе, реализацию потенциала трафика и интегральные оценки внутренней и внешней оптимизации и поведенческих факторов. Все методы синхронные и считают по уже снятым позициям.
- Адрес
/projects/api/v1/summary/<блок>/<метод>,/projects/api/v1/integrals/get- Режим
- синхронный
- Лимиты
- вызов не тратит
Динамика видимости
/projects/api/v1/summary/visibility/get
Видимость сайта, сводно по всем поисковым системам проекта, на каждый апдейт позиций за период, который заканчивается датой to. Длина периода — интервал сводки из настроек проектов (обычно 30 дней), но не раньше даты создания проекта.
Параметры query
-
tokenstring обязательныйКлюч API из настроек аккаунта — тот же, чтоkeyу методов инструментов. -
project_idint обязательныйID проекта. Виден в адресе страницы проекта и в ответе projects/get. -
todateКонец периода,ГГГГ-ММ-ДД, не позже сегодняшнего дня. -
modestringЧто отдать.
Ответ
-
result[].datedateДата апдейта,ГГГГ-ММ-ДД. -
result[].visibilityfloatВидимость, % от 0 до 100.
Изменение видимости между апдейтами
/projects/api/v1/summary/visibility/change
Видимость на выбранном апдейте и на предыдущем (закончившемся в другой день) — сводно и по каждой поисковой системе проекта, — и признак резкого падения по порогам из настроек проектов. Без update_id и date_update берётся последний успешный апдейт.
Параметры query
-
tokenstring обязательныйКлюч API из настроек аккаунта — тот же, чтоkeyу методов инструментов. -
project_idint обязательныйID проекта. Виден в адресе страницы проекта и в ответе projects/get. -
update_idintID апдейта из updates/get. -
date_updatedateВместоupdate_id: апдейт, закончившийся в эту дату, а если такого нет — ближайший после неё. Важнееupdate_id.
Ответ
-
result.updatesobjectcurrentиprevious— строки апдейтов:id,dt_start,dt_end,status,queries_countи др. -
result.dictionaryobjectНазвания: ключ0— «Все поисковые системы», остальные — ID поисковых систем проекта. -
result.search_systems_dataobjectКлючи те же, что вdictionary:currentиprevious— видимость в %,diff— разница. -
result.limitsobjectПороги падения из настроек:absolute— в пунктах,relative— в процентах. -
result.warningsobjectstatus— превышен ли порог хотя бы где-то,search_systems— где именно (ключиdictionary).
Реализация потенциала трафика
/projects/api/v1/summary/potential/get
Какую долю от максимально возможного трафика сайт собирает на последнем апдейте: прогнозный трафик по текущим позициям относительно трафика, если бы все запросы стояли на первом месте. Сводно по всем поисковым системам проекта.
Параметры query
-
tokenstring обязательныйКлюч API из настроек аккаунта — тот же, чтоkeyу методов инструментов. -
project_idint обязательныйID проекта. Виден в адресе страницы проекта и в ответе projects/get.
Ответ
Пустой result, если у проекта ещё нет успешных апдейтов.
-
result.datedateДата последнего апдейта. -
result.potentialfloatРеализация потенциала, % от 0 до 100.
Интегральные оценки
/projects/api/v1/integrals/get
Последние значения трёх оценок проекта: внутренняя оптимизация (intopt), ссылочная масса (extopt) и поведенческие факторы (pf). С date — последние значения на эту дату. Те же оценки вместе со сводной отдаёт project/get с details=1.
Параметры query
-
tokenstring обязательныйКлюч API из настроек аккаунта — тот же, чтоkeyу методов инструментов. -
project_idint обязательныйID проекта. Виден в адресе страницы проекта и в ответе projects/get. -
datedateВзять значения, рассчитанные не позже этой даты,ГГГГ-ММ-ДД. Наpfне действует — для него всегда последнее значение.
Ответ
Объект без обёртки status/result. Если оценка ни разу не считалась — value равно N/A, а date — 1970-01-01.
-
intopt, extopt, pfobjectvalue— значение оценки,date— когда рассчитана.
Ошибки
| Код | Сообщение | Когда |
|---|---|---|
50 |
access error |
Токен не передан, не найден, или у его владельца нет доступа к проекту. |
52 |
wrong request data |
visibility/get: to не дата или позже сегодняшнего дня, mode не из списка — причина в result.error_message; эта проверка идёт раньше проверки токена. visibility/change: у проекта нет ни одного успешного апдейта. |
Видимость — доля возможных переходов из поиска, которую сайт собирает своими позициями по запросам проекта, с учётом частоты запросов и весов поисковых систем. Подробнее о показателях — на «Сводке» проекта.
Если для visibility/change передан апдейт, которого нет, ответ успешный, но без сравнения: updates и search_systems_data пустые, limits и warnings нет.
Параметры читаются из query-строки; update_id и date_update принимаются и из тела POST-формы. HTTP-код при штатной ошибке — 200: успех и ошибка различаются полями status и code.