Методы — Видимость в AI

Раздел содержит методы для получения построчных данных экрана «Видимость в AI»: ответы нейросетей на промпты проекта, метрики упоминания бренда проекта и конкурентов. Идентификаторы нейросетей и даты съёмов берутся из справочников ai-visibility/networks и ai-visibility/checks.

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

Возвращает результаты проверки всех промптов проекта для одной нейросети на конкретную дату съёма.

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

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

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

{
    id: number,
    prompt: string,
    neuralNetworkId: number,
    neuralNetworkName: string,
    neuralNetworkCode: string,
    checkedAt: string,
    answer: string,
    brandMentioned: boolean | null,
    dynamic: number,
    sentiment: number | null,
    domainMention: boolean | null,
    domainLink: string | null,
    competitorMentioned: boolean | null
}

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

Возвращает агрегированные метрики упоминаний выбранного конкурента по одной нейросети за диапазон дат съёма. Построчные данные по промптам (ответы нейросетей, упоминания бренда) — см. метод api/v1/ai-prompts/data.

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

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

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

{
    id: number,
    rivalId: number,
    checkedAt: string,
    networkId: number,
    networkCode: string,
    networkName: string,
    visibility: number,
    mentionsCount: number,
    positiveCount: number,
    negativeCount: number,
    neutralCount: number,
    positivePercent: number,
    negativePercent: number,
    neutralPercent: number
}