API – Видимость / Страницы

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

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

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

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

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

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

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

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

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

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

Имя	Описание
`date`	Дата апдейта
`search_engine`	Поисковая система
`id`	id страницы
`document`	url страницы
`category_id`	id категории, в которой находится страница
`category_name`	Имя категории, в которой находится страница
`queries_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-15",
        "search_engine": "yandex",
        "id": "1312010",
        "document": "https://url.com/path/017030/",
        "category_id": "055812",
        "category_name": "категория",
        "queries_count": 146,
        "position_avg": 24.68,
        "top0_count": 0,
        "top1_count": 0,
        "top3_count": 0,
        "top5_count": 2,
        "top10_count": 8,
        "top30_count": 65,
        "top0_prc": 0,
        "top1_prc": 0,
        "top3_prc": 0,
        "top5_prc": 1.37,
        "top10_prc": 5.48,
        "top30_prc": 44.52,
        "ws1": 108059,
        "ws2": 13361,
        "ws1_top0_count": 0,
        "ws2_top0_count": 0,
        "ws1_top1_count": 0,
        "ws2_top1_count": 0,
        "ws1_top3_count": 0,
        "ws2_top3_count": 0,
        "ws1_top5_count": 216,
        "ws2_top5_count": 34,
        "ws1_top10_count": 1504,
        "ws2_top10_count": 172,
        "ws1_top0_prc": 0,
        "ws2_top0_prc": 0,
        "ws1_top1_prc": 0,
        "ws2_top1_prc": 0,
        "ws1_top3_prc": 0,
        "ws2_top3_prc": 0,
        "ws1_top5_prc": 0.2,
        "ws2_top5_prc": 0.25,
        "ws1_top10_prc": 1.39,
        "ws2_top10_prc": 1.29,
        "p_traf": 2.69,
        "p_traf_prc": 0.2,
        "traffic_organic": 27,
        "traffic_yandex_prc": 0,
        "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
}

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