Зарегистрироваться
View Categories

Методы

GET: api/v1/projects/visibility?{ops} #

Возвращает данные по видимости в разрезе проекта или конкурента.

Входные параметры #
ПараметрОписаниеЗначение по умолчаниюОбязательный
project_idid проектанетда
date_fromДата начала диапазона в формате YYYY-MM-DDнетда
date_toДата окончания диапазона в формате YYYY-MM-DDтекущая датанет
serp_engineid поисковой системы, если не указан, данные будут возвращены по всем системамне заданнет
rival_idid конкурента, если не указан, данные будут возвращены по проектуне заданнет
Возвращаемый результат #

В поле data будет возвращен массив объектов следующего вида:

{
    freq_type: number
    check_date: string
    serp_engine_id: number
    visibility: number
}

GET: api/v1/keywords?{ops} #

Возвращает список ключей с позициями и частотностью. В запрос возможно передать диапазон дат, для выгрузки данных за период более 1 дня. Максимально допустимый диапазон 30 дней.

Входные параметры #
ПараметрОписаниеЗначение по умолчаниюОбязательный
project_idid проектанетда
date_fromДата начала диапазона в формате YYYY-MM-DDнетда
date_toДата окончания диапазона в формате YYYY-MM-DDтекущая датанет
serp_engineid поисковой системы, если не указан, данные будут возвращены по всем системамне заданнет
Возвращаемый результат #

В поле data будет возвращен массив объектов следующего вида:

{
    id: number,
    key: string,
    page: number,
    positions: {
        date: string,
        position: number,
        rel_page: string,
        serp_engine: number,
    }[],
    frequency: {
        date: string,
        frequency: number,
        freq_type: number,
        serp_engine: number,
    }[]
}

GET: api/v1/keywords/by-tags?{ops} #

Входные параметры #
Параметр Описание Значение по умолчанию Обязательный
project_id ID проекта нет да
date Конкретная дата в формате YYYY-MM-DD нет да
serp_engine ID поисковой системы нет да
tag_ids Массив ID тегов, если не указан — все теги проекта все теги нет
frequency_type ID типа частотности не задан нет
limit Количество записей для пагинации не задан нет
offset Смещение для пагинации не задан нет
Возвращаемый результат #

В поле data будет возвращен массив объектов следующего вида:

{
    id: number,
    name: string,
    top3: number,
    top10: number,
    top30: number,
    top3_pcnt: number,
    top10_pcnt: number,
    top30_pcnt: number,
    ws_data: [
        {
            ws_type: number,
            ws_value: number,
            alfa_traf: number
        }
    ]
}

GET: api/v1/metrics?{ops} #

Возвращает динамику метрик сайта по датам.

Входные параметры #
ПараметрОписаниеЗначение по умолчаниюОбязательный
metricКод метрики. Допустимые значения: visibility, alfaTraf, top1, top3, top5, top10, top20, top100, keywordStatнетда
project_idID сайта (проекта)нетда
dates[]Диапазон дат в формате YYYY-MM-DD. Первый элемент — дата начала, второй — дата окончаниянетда
serp_engine_idID поисковой системынетда
page_idID страницы для фильтрациинетнет
section_idID раздела для фильтрациинетнет
stat_type_idID типа статистикинетнет
Возвращаемый результат #

В поле data будет возвращен массив объектов:

{
    status: ok,
    data: [
        {
            date: 2026-01-01,
            value: 42.5
        },
        {
            date: 2026-01-15,
            value: 45.1
        },
        {
            date: 2026-01-31,
            value: 43.8
        }
    ]
}
Пример запроса #
    GET /api/v1/metrics?metric=visibility&project_id=1&serEngineId=1&dates[]=2026-01-01&dates[]=2026-01-31
Top