Методы

Общая информация #

Раздел посвящен описанию методов API и их интерфейсов. API можно разделить на 2 большие части, это данные и справочники.

В этом раздделе не будет приводиться информация о базовых параметрах запросов, а так же полные структуры ответов. Для получения этой информации перейдите в разде Работа с API.

Все методы принимают 2 не обязательных параметра:

Справочники #

Нижеперечисленные методы позволяют получить списки доступных проектов, сраниц и посиковых систем.

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

Возвращает список, доступных пользователю, проектов.

Входные параметры #

Специальных параметров не требуется.

Возвращаемый результат #

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

{
    id: number
    name: string
    url: string
}

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

Возвращает список страниц проекта.

Входные параметры #

Возвращаемый результат #

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

{
    id: number
    name: string
    url: string
}

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

Возвращает список поисковых систем проекта.

Входные параметры #

Возвращаемый результат #

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

{
    id: number
    searcher: 'Yandex'|'Google'
    region: string
    devce: 'pc'|'mob'
}

Данные #

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

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

Входные параметры #

Возвращаемый результат #

В поле 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,
    }[]
}

Типы частотности #

Возвращаемая частотность может быть 4х типов: