Справочники

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

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

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

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

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

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

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

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

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

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

{
    id: number
    name: string
    url: string
}

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

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

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

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

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

{
    id: number
    host: string
    tracked: boolean
}

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

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

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

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

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

{
    id: number
    name: string
    url: string
    categoryId: number
}

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

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

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

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

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

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

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

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

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

Возвращает список категорий (разделов) проекта.

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

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

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

{
    id: number
    name: string
}

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

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

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

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

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

{
    id: number
    checkDate: string
    serpEngineId: number
    engineName: string
}

GET: api/v1/ai-visibility/networks?{ops} #

Возвращает список нейросетей, подключённых для проверки в проекте («Видимость в AI»).

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

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

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

{
    id: number,
    name: string,
    code: string
}

GET: api/v1/ai-visibility/checks?{ops} #

Возвращает список завершённых съёмов «Видимости в AI» по проекту, отсортированный по дате по убыванию.

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

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

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

{
    id: number,
    date: string
}

GET: api/v1/ai-rivals?{ops} #

Возвращает список отслеживаемых конкурентов проекта для «Видимости в AI» вместе с указанными брендами.

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

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

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

{
    id: number,
    host: string,
    brandNames: string | null
    tracked: boolean
}