competitors Конкуренты: видимость доменов в выдаче по запросам проекта
Отдаёт данные отчёта «Анализ конкурентов» проекта: какие домены встречаются в выдаче по запросам проекта, их видимость, прогнозный трафик и попадания в ТОП-10 и ТОП-100, изменение за период и ряды для графика. Метод синхронный — считает по уже снятым позициям.
- Адрес
/projects/api/v1/competitors/get- Режим
- синхронный
- Лимиты
- вызов не тратит
- Доменов
- до 150 в ответе
Конкуренты за период
/projects/api/v1/competitors/get
Берёт апдейты позиций проекта в интервале from–to. Таблица table_data — значения на самом свежем апдейте интервала и разница с самым старым; chart_data — значения по каждому апдейту для графика. Домен проекта и домены из списка конкурентов в настройках проекта есть в ответе всегда — с нулями, если в выдаче их не нашлось.
Параметры query
-
tokenstring обязательныйКлюч API из настроек аккаунта — тот же, чтоkeyу методов инструментов. -
project_idint обязательныйID проекта. Виден в адресе страницы проекта и в ответе projects/get. -
search_system_idstringID поисковой системы проекта из search-systems/get илиall— сводно по всем системам проекта. -
fromdateНачало периода,ГГГГ-ММ-ДД. По умолчанию — 30 дней доto. Раньше даты создания проекта и раньше 2020-03-30 не опускается. -
todateКонец периода. По умолчанию и при дате в будущем — сегодня. -
typesarrayТипы конкурентов. Одно значение строкой или несколько какtypes[]=primary&types[]=direct.
Ответ
-
result.table_dataobjectДомены, ключ — ID домена. Домен проекта идёт первым, остальные — по убыванию видимости.Вложенные поля
-
domain_id, domainstringID и имя домена. -
update_idstringАпдейт, на котором сняты значения. -
type_idstringТип конкурента изuser_domain_types. -
visibilityfloatВидимость, %. -
ctr_wsfloatПрогнозный трафик (CTR × частота) по запросам проекта. -
top_ten, top_hundredintСколько раз домен попал в ТОП-10 и ТОП-100. -
visibility_delta, ctr_ws_delta, top_ten_delta, top_hundred_deltafloatИзменение относительно самого старого апдейта периода. -
visibility_arr, ctr_ws_arr, top_ten_arr, top_hundred_arrobjectТолько приsearch_system_id=all: те же показатели в разрезе поисковых систем, ключ — ID системы; у видимости ещёweight— вес системы в сводной оценке.
-
-
result.chart_dataobjectРяды для графика.Вложенные поля
-
default_domainsstring[]Домены, которые показывать на графике по умолчанию. -
visibility, ctr_ws, top_ten, top_hundredobjectКлюч — домен, значение — точки{x: "ДД.ММ.ГГГГ", y: число}по апдейтам. -
optionsobjectДля каждого показателя —min,maxи подпись осиy_axis.
-
-
result.user_domain_typesobjectСправочник типов конкурентов:id,name,slug,order_by. -
result.ss_name, result.ss_regionstringНазвание поисковой системы и регион; дляall— «Все поисковые системы» и пустая строка.
Ошибки
| Код | Сообщение | Когда |
|---|---|---|
50 |
access error |
Токен не передан, не найден, или у его владельца нет доступа к проекту. |
52 |
wrong request data |
Проекта с таким project_id нет. |
Если у проекта ещё нет ни одного успешного апдейта позиций, метод отвечает успехом с пустым result. Если апдейты есть, но не в выбранном периоде, — table_data и ряды графика пустые.
search_system_id должен быть ID системы именно этого проекта из search-systems/get. С чужим или несуществующим ID сервер отвечает ошибкой 500 вместо JSON.
Параметры принимаются и из query-строки, и из тела POST-формы. HTTP-код при штатной ошибке — 200: успех и ошибка различаются полями status и code.