SEO-проекты · token

competitors Конкуренты: видимость доменов в выдаче по запросам проекта

Отдаёт данные отчёта «Анализ конкурентов» проекта: какие домены встречаются в выдаче по запросам проекта, их видимость, прогнозный трафик и попадания в ТОП-10 и ТОП-100, изменение за период и ряды для графика. Метод синхронный — считает по уже снятым позициям.

Адрес
/projects/api/v1/competitors/get
Режим
синхронный
Лимиты
вызов не тратит
Доменов
до 150 в ответе

Конкуренты за период

GET /projects/api/v1/competitors/get

Берёт апдейты позиций проекта в интервале from–to. Таблица table_data — значения на самом свежем апдейте интервала и разница с самым старым; chart_data — значения по каждому апдейту для графика. Домен проекта и домены из списка конкурентов в настройках проекта есть в ответе всегда — с нулями, если в выдаче их не нашлось.

Параметры query

  • token string обязательный
    Ключ API из настроек аккаунта — тот же, что key у методов инструментов.
  • project_id int обязательный
    ID проекта. Виден в адресе страницы проекта и в ответе projects/get.
  • search_system_id string
    ID поисковой системы проекта из search-systems/get или all — сводно по всем системам проекта.
    По умолчанию all
  • from date
    Начало периода, ГГГГ-ММ-ДД. По умолчанию — 30 дней до to. Раньше даты создания проекта и раньше 2020-03-30 не опускается.
  • to date
    Конец периода. По умолчанию и при дате в будущем — сегодня.
  • types array
    Типы конкурентов. Одно значение строкой или несколько как types[]=primary&types[]=direct.
    all
    все
    primary
    ключевой
    direct
    прямой
    indirect
    косвенный
    По умолчанию all

Ответ

  • result.table_data object
    Домены, ключ — ID домена. Домен проекта идёт первым, остальные — по убыванию видимости.
    Вложенные поля
    • domain_id, domain string
      ID и имя домена.
    • update_id string
      Апдейт, на котором сняты значения.
    • type_id string
      Тип конкурента из user_domain_types.
    • visibility float
      Видимость, %.
    • ctr_ws float
      Прогнозный трафик (CTR × частота) по запросам проекта.
    • top_ten, top_hundred int
      Сколько раз домен попал в ТОП-10 и ТОП-100.
    • visibility_delta, ctr_ws_delta, top_ten_delta, top_hundred_delta float
      Изменение относительно самого старого апдейта периода.
    • visibility_arr, ctr_ws_arr, top_ten_arr, top_hundred_arr object
      Только при search_system_id=all: те же показатели в разрезе поисковых систем, ключ — ID системы; у видимости ещё weight — вес системы в сводной оценке.
  • result.chart_data object
    Ряды для графика.
    Вложенные поля
    • default_domains string[]
      Домены, которые показывать на графике по умолчанию.
    • visibility, ctr_ws, top_ten, top_hundred object
      Ключ — домен, значение — точки {x: "ДД.ММ.ГГГГ", y: число} по апдейтам.
    • options object
      Для каждого показателя — min, max и подпись оси y_axis.
  • result.user_domain_types object
    Справочник типов конкурентов: id, name, slug, order_by.
  • result.ss_name, result.ss_region string
    Название поисковой системы и регион; для 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.

Обратная связь и помощь
Если у вас есть идеи, как улучшить данный инструмент или остались вопросы по работе с ним, напишите в нашу службу поддержки, мы обязательно вам поможем.