API – Конкуренты

Описание API-методов для работы с модулем Конкуренты.

Для начала работы с API SEOWORK необходимо обратиться в поддержку по почте help@seowork.ru или в чате на сайте. Для вас будет создан API токен.

Получение конкурентов с метриками за выбранную дату

GET https://api.seowork.ru/api/v5/competition/project/{project_id}

В запросе укажите следующие параметры:

Имя	Обязательный	Тип	Значение по умолчанию	Описание
`project_id`	Да	`integer`		id проекта
`token`	Да	`string`		Токен авторизации
`date`	Да	`string`		Дата в формате yyyy-mm-dd
`competition_statistics_multi_version`	Нет	`integer`	0	Фильтр "по лучшей" (0) или "по всем" (1)
`search_engine`	Нет	`string`	yandex - для проектов seowork.ru google - для проектов seowork.io	Поисковая система
`host_names`	Нет	`array[string]`		Массив хостов конкурентов
`limit`	Нет	`integer`	1000	Количество конкурентов на странице (до `1000`)
`offset`	Нет	`integer`	0	Пропуск записей для пагинации
`top`	Нет	`integer`	10	Топ позиций (до `30`)
`my_site`	Нет	`integer`	1	Отображение вашего сайта (`0/1`)
`favorite`	Нет	`integer`	0	Только избранные (`1`) или все (`0`)
`segment_type`	Нет	`string`		Тип сегмента (`category, group, query_group`), работает только в связке с `segment_name`
`segment_name`	Нет	`string`		Название сегмента, работает только в связке с `segment_type`
`is_total`	Нет	`integer`	1	Отображает количество всех найденных конкурентов. Значение `"total"` не будет 0, если `is_total=1`. Параметр нагружает систему. Без острой необходимости, просьба не использовать

Для получения даты апдейта используйте отдельный API запрос.

Например:

https://api.seowork.ru/api/v5/competition/project/1234?token=...&date=2023-05-26&competition_statistics_multi_version=1&search_engine=yandex&host_names[0]=site1.ru&host_names[1]=site2.ru&host_names[2]=site3.ru&limit=50&offset=0&top=10&my_site=1&favorite=0&segment_type=category&segment_name=тест%20сегмент

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

Объект в формате json, в котором содержится список доступных проектов с перечислением их свойств:

Имя	Описание
`date`	Дата апдейта
`host`	Хост конкурента
`isFavorite`	Избранный конкурент
`count`	Количество запросов в топе заданной глубины
`ws1`	Сумма частотности WS1 всех запросов в топе заданной глубины
`ws2`	Сумма частотности WS2 всех запросов в топе заданной глубины
`ptraf`	Потенциальный трафик всех запросов в топе заданной глубины
`count_prc`	Процент запросов в топе заданной глубины от всех запросов проекта или сегмента
`ws1_prc`	%WS1 всех запросов в топе заданной глубины от суммы частотности всех запросов проекта или сегмента
`ws2_prc`	%WS2 всех запросов в топе заданной глубины от суммы частотности всех запросов проекта или сегмента
`ptraf_prc`	Процентный показатель потенциального трафика

{
   "has_data": true,
   "data": {
      "items": [
         {
            "date": "2023-05-23",
            "host": "site1.ru",
            "isFavorite": 0,
            "count": 143538,
            "ws1": 152827000,
            "ws2": 6280839,
            "ptraf": 533246,
            "count_prc": 97,
            "ws1_prc": 98,
            "ws2_prc": 98,
            "ptraf_prc": 83
         },
         {
            "date": "2023-05-23",
            "host": "site2.ru",
            "isFavorite": 1,
            "count": 111879,
            "ws1": 104363129,
            "ws2": 5363596,
            "ptraf": 172842,
            "count_prc": 76,
            "ws1_prc": 67,
            "ws2_prc": 84,
            "ptraf_prc": 27
         },
         {
            "date": "2023-05-23",
            "host": "site3.ru",
            "isFavorite": 0,
            "count": 67403,
            "ws1": 95350687,
            "ws2": 3631857,
            "ptraf": 138821,
            "count_prc": 45,
            "ws1_prc": 61,
            "ws2_prc": 56,
            "ptraf_prc": 21
         }
      ],
      "limit": 2,
      "offset": "0",
      "total": 3
   },
   "version": null,
   "status": 200,
   "error": 0,
   "error_messages": [],
   "response_time": 0.0000000000000001,
   "server_timestamp": "2023-05-26 00:00:00",
   "server_unixtimestamp": 1685059200
}

👆 На этом пока всё