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

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

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

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

https://api.seowork.ru/semantics/api/v5/dashboard/group

Для получения используется 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


Страница

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


Например:

https://api.seowork.ru/semantics/api/v5/dashboard/group?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-15",
        "id": 131131,
        "name": "группа страниц",
        "queries_count": 29758,
        "documents_count": 653,
        "position_avg": 11.18,
        "top0_count": 0,
        "top1_count": 986,
        "top3_count": 4190,
        "top5_count": 10165,
        "top10_count": 20552,
        "top30_count": 24887,
        "top0_prc": 0,
        "top1_prc": 3.31,
        "top3_prc": 14.08,
        "top5_prc": 34.16,
        "top10_prc": 69.06,
        "top30_prc": 83.63,
        "ws1": 34447759,
        "ws2": 938374,
        "ws1_top0_count": 0,
        "ws2_top0_count": 0,
        "ws1_top1_count": 953116,
        "ws2_top1_count": 41280,
        "ws1_top3_count": 5039830,
        "ws2_top3_count": 163274,
        "ws1_top5_count": 10735232,
        "ws2_top5_count": 343851,
        "ws1_top10_count": 24933508,
        "ws2_top10_count": 675824,
        "ws1_top0_prc": 0,
        "ws2_top0_prc": 0,
        "ws1_top1_prc": 2.77,
        "ws2_top1_prc": 4.4,
        "ws1_top3_prc": 14.63,
        "ws2_top3_prc": 17.4,
        "ws1_top5_prc": 31.16,
        "ws2_top5_prc": 36.64,
        "ws1_top10_prc": 72.38,
        "ws2_top10_prc": 72.02,
        "p_traf": 24108.77,
        "p_traf_prc": 25.69,
        "traffic_organic": 103818,
        "traffic_yandex_prc": 58607,
        "traffic_google_prc": 44646
      },
      ...
    ],
    "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
}
👆 На этом пока всё