API – Видимость / Категории

Описание API-методов v5 для работы с модулем Видимость

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

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

GET https://api.seowork.ru/semantics/api/v5/dashboard/category

Для получения используется GET-запрос со следующими параметрами:

Имя	Обязательный	Тип	Значение по умолчанию	Описание
`project_id`	Да	`integer`		id проекта
`token`	Да	`string`		Токен авторизации
`date`	Нет	`string`	Последняя дата апдейта	Дата в формате yyyy-mm-dd
`search_engine`	Нет	`string`	yandex - для проектов seowork.ru google - для проектов seowork.io	Поисковая система
`limit`	Нет	`integer`		Количество записей на странице (до `1000` строк)
`offset`	Нет	`integer`		Пропуск записей для пагинации
`page`	Нет	`integer`		Страница

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

https://api.seowork.ru/semantics/api/v5/dashboard/category?token=...&project_id=123&date=2019-12-20&search_engine=yandex

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

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

Имя	Описание
`date`	Дата апдейта
`id`	id категории
`name`	Название категории
`queries_count`	Количество запросов в категории
`documents_count`	Количество страниц в категории
`position_avg`	Средняя позиция
`top0_count`	Количество запросов на нулевой позиции
`top1_count`	Количество запросов в топ-1
`top3_count`	Количество запросов в топ-3
`top5_count`	Количество запросов в топ-5
`top10_count`	Количество запросов в топ-10
`top30_count`	Количество запросов в топ-30
`top0_prc`	Процент запросов на нулевой позиции
`top1_prc`	Процент запросов в топ-1
`top3_prc`	Процент запросов в топ-3
`top5_prc`	Процент запросов в топ-5
`top10_prc`	Процент запросов в топ-10
`top30_prc`	Процент запросов в топ-30
`ws1`	Сумма частотности WS1 всех запросов
`ws2`	Сумма частотности WS2 всех запросов
`ws1_top0_count`	Сумма частотности WS1 всех запросов на нулевой позиции
`ws2_top0_count`	Сумма частотности WS2 всех запросов на нулевой позиции
`ws1_top1_count`	Сумма частотности WS1 всех запросов в топ-1
`ws2_top1_count`	Сумма частотности WS2 всех запросов в топ-1
`ws1_top3_count`	Сумма частотности WS1 всех запросов в топ-3
`ws2_top3_count`	Сумма частотности WS2 всех запросов в топ-3
`ws1_top5_count`	Сумма частотности WS1 всех запросов в топ-5
`ws2_top5_count`	Сумма частотности WS2 всех запросов в топ-5
`ws1_top10_count`	Сумма частотности WS1 всех запросов в топ-10
`ws2_top10_count`	Сумма частотности WS2 всех запросов в топ-10
`ws1_top0_prc`	%WS1 всех запросов на нулевой позиции от суммы частотности всех запросов категории
`ws2_top0_prc`	%WS2 всех запросов на нулевой позиции от суммы частотности всех запросов категории
`ws1_top1_prc`	%WS1 всех запросов в топ-1 от суммы частотности всех запросов категории
`ws2_top1_prc`	%WS2 всех запросов в топ-1 от суммы частотности всех запросов категории
`ws1_top3_prc`	%WS1 всех запросов в топ-3 от суммы частотности всех запросов категории
`ws2_top3_prc`	%WS2 всех запросов в топ-3 от суммы частотности всех запросов категории
`ws2_top5_prc`	%WS1 всех запросов в топ-5 от суммы частотности всех запросов категории
`ws2_top5_prc`	%WS2 всех запросов в топ-5 от суммы частотности всех запросов категории
`ws1_top10_prc`	%WS1 всех запросов в топ-10 от суммы частотности всех запросов категории
`ws2_top10_prc`	%WS2 всех запросов в топ-10 от суммы частотности всех запросов категории
`p_traf`	Потенциальный трафик
`p_traf_prc`	Процентный показатель потенциального трафика
`traffic_organic`	Органический трафик
`traffic_yandex_prc`	Процент органического трафика из поисковой системы Яндекс
`traffic_google_prc`	Процент органического трафика из поисковой системы Google

{
  "has_data": true,
  "data": {
    "items": [
      {
        "date": "2024-03-30",
        "id": 123321,
        "name": "категория",
        "queries_count": 21430,
        "documents_count": 9283,
        "position_avg": 5.67,
        "top0_count": 0,
        "top1_count": 9364,
        "top3_count": 12703,
        "top5_count": 14959,
        "top10_count": 18422,
        "top30_count": 20203,
        "top0_prc": 0,
        "top1_prc": 43.7,
        "top3_prc": 59.28,
        "top5_prc": 69.8,
        "top10_prc": 85.96,
        "top30_prc": 94.27,
        "ws1": 17486640,
        "ws2": 911736,
        "ws1_top0_count": 0,
        "ws2_top0_count": 0,
        "ws1_top1_count": 1273483,
        "ws2_top1_count": 66263,
        "ws1_top3_count": 2648692,
        "ws2_top3_count": 143023,
        "ws1_top5_count": 4996604,
        "ws2_top5_count": 245244,
        "ws1_top10_count": 10318779,
        "ws2_top10_count": 468086,
        "ws1_top0_prc": 0,
        "ws2_top0_prc": 0,
        "ws1_top1_prc": 7.28,
        "ws2_top1_prc": 7.27,
        "ws1_top3_prc": 15.15,
        "ws2_top3_prc": 15.69,
        "ws1_top5_prc": 28.57,
        "ws2_top5_prc": 26.9,
        "ws1_top10_prc": 59.01,
        "ws2_top10_prc": 51.34,
        "p_traf": 18939.07,
        "p_traf_prc": 20.77,
        "traffic_organic": 19827,
        "traffic_yandex_prc": 100,
        "traffic_google_prc": 0
      },
      ...
    ],
    "count": 9,
    "total": 9,
    "limit": 100,
    "page": 1
  },
  "version": 1,
  "status": 200,
  "error": 0,
  "error_messages": [],
  "response_time": 0.0000000000000001,
  "server_timestamp": "2023-05-26 00:00:00",
  "server_unixtimestamp": 1685059200
}

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