Public API

Обзор

VisioBrand Public API позволяет программно получать данные о видимости бренда в AI-платформах. API доступен на всех платных тарифах.

Базовый URL: https://platform.visiobrand.io/api/v1

Аутентификация

Передайте API ключ в заголовке X-API-Key:

curl -H "X-API-Key: gc_live_your_key_here" \
  https://platform.visiobrand.io/api/v1/brands

Также поддерживается Authorization: Bearer gc_live_...

Получение API ключа

Перейдите в Аккаунт → API ключи
Нажмите Создать ключ
Скопируйте ключ (он показывается только один раз)

Лимиты запросов

Тариф	Запросов в час
Лайт	100
Старт	500
Про	2 000

Заголовки ответа содержат информацию о лимитах:

X-RateLimit-Limit — максимум запросов
X-RateLimit-Remaining — осталось запросов
X-RateLimit-Reset — время сброса (Unix timestamp)

Формат ответа

Все ответы в формате JSON:

{
  "success": true,
  "data": { ... },
  "meta": {
    "timestamp": "2026-04-02T13:08:21.421Z"
  }
}

При ошибке:

{
  "success": false,
  "error": "Описание ошибки"
}

Endpoints

GET /brands

Список всех брендов компании.

curl -H "X-API-Key: $KEY" https://platform.visiobrand.io/api/v1/brands

Ответ:

{
  "success": true,
  "data": [
    {
      "id": "uuid",
      "name": "VisioBrand",
      "website": "visiobrand.io",
      "industry": "SaaS",
      "testSlotTime": "03:00",
      "createdAt": "2025-01-15T10:00:00Z"
    }
  ]
}

GET /brands/:id/visibility

Текущая видимость бренда с трендом и разбивкой по AI-моделям.

Параметры:

Параметр	Тип	По умолчанию	Описание
`period`	string	`30d`	Период: `7d`, `30d`, `90d`
`model`	string	—	Фильтр по модели

curl -H "X-API-Key: $KEY" \
  "https://platform.visiobrand.io/api/v1/brands/{id}/visibility?period=30d"

Ответ:

{
  "success": true,
  "data": {
    "brandId": "uuid",
    "brandName": "VisioBrand",
    "period": "30d",
    "visibility": {
      "current": 25.9,
      "previous": 24.31,
      "changePercent": 6.58,
      "trend": "up"
    },
    "mentions": {
      "current": 3124,
      "previous": 1670,
      "changePercent": 87.07,
      "timeline": [
        { "date": "2026-03-03", "count": 81 },
        { "date": "2026-03-04", "count": 68 }
      ]
    },
    "models": [
      {
        "model": "alice",
        "visibility": 44.14,
        "totalTests": 2771,
        "successfulMentions": 1223,
        "mentionRate": 44,
        "avgPosition": 1.8
      }
    ]
  }
}

GET /brands/:id/mentions

Детализация упоминаний по AI-моделям с таймлайном.

Параметры:

Параметр	Тип	По умолчанию	Описание
`period`	string	`30d`	Период
`model`	string	—	Фильтр по модели

curl -H "X-API-Key: $KEY" \
  "https://platform.visiobrand.io/api/v1/brands/{id}/mentions?period=30d"

Ответ:

{
  "success": true,
  "data": {
    "brandId": "uuid",
    "totalMentions": 3124,
    "total": 9,
    "byModel": [
      {
        "model": "alice",
        "visibility": 44.14,
        "totalTests": 2771,
        "successfulMentions": 1223,
        "mentionRate": 44,
        "avgPosition": 1.8
      }
    ],
    "timeline": [
      { "date": "2026-03-03", "mentionsCount": 81 }
    ]
  }
}

GET /brands/:id/competitors

Сравнение видимости бренда с конкурентами — рейтинг, доля голоса, тональность.

Параметры:

Параметр	Тип	По умолчанию	Описание
`period`	string	`30d`	Период

curl -H "X-API-Key: $KEY" \
  "https://platform.visiobrand.io/api/v1/brands/{id}/competitors"

Ответ:

{
  "success": true,
  "data": {
    "brandId": "uuid",
    "period": "30d",
    "rankings": [
      {
        "rank": 1,
        "name": "VisioBrand",
        "isYourBrand": true,
        "visibility": 25.9,
        "mentions": 3124,
        "avgPosition": 2.1,
        "sentiment": 65,
        "shareOfVoice": 21
      },
      {
        "rank": 2,
        "name": "Конкурент A",
        "isYourBrand": false,
        "visibility": 24.09,
        "mentions": 2890,
        "avgPosition": 2.3,
        "sentiment": 58,
        "shareOfVoice": 26
      }
    ]
  }
}

GET /brands/:id/prompts

Список мониторинговых промптов с настройками.

Параметры:

Параметр	Тип	По умолчанию	Описание
`limit`	number	`50`	Количество (1-100)

curl -H "X-API-Key: $KEY" \
  "https://platform.visiobrand.io/api/v1/brands/{id}/prompts?limit=10"

Ответ:

{
  "success": true,
  "data": {
    "brandId": "uuid",
    "total": 50,
    "prompts": [
      {
        "id": "uuid",
        "name": "Лучший сервис аналитики",
        "text": "Ищу лучший сервис для аналитики брендов в нейросетях",
        "type": "informational",
        "trackingEnabled": true,
        "nextTestDate": "2026-04-03",
        "createdAt": "2025-12-01T10:00:00Z"
      }
    ]
  }
}

GET /brands/:id/models

Разбивка видимости по каждой AI-платформе.

Параметры:

Параметр	Тип	По умолчанию	Описание
`period`	string	`30d`	Период

curl -H "X-API-Key: $KEY" \
  "https://platform.visiobrand.io/api/v1/brands/{id}/models?period=30d"

Ответ:

{
  "success": true,
  "data": {
    "brandId": "uuid",
    "period": "30d",
    "models": [
      {
        "model": "alice",
        "visibility": 44.14,
        "totalTests": 2771,
        "successfulMentions": 1223,
        "mentionRate": 44,
        "avgPosition": 1.8
      },
      {
        "model": "chatgpt",
        "visibility": 12.5,
        "totalTests": 2400,
        "successfulMentions": 300,
        "mentionRate": 12,
        "avgPosition": 2.5
      }
    ]
  }
}

Доступные AI-платформы:

Значение `model`	Платформа
`chatgpt`	ChatGPT
`gemini`	Google Gemini
`alice`	Алиса AI
`deepseek`	DeepSeek
`yandex_search`	Яндекс Поиск с Алисой
`perplexity`	Perplexity
`gigachat`	GigaChat (Сбер)
`google_aio`	Google AI Overviews

GET /brands/:id/trends

Динамика видимости по дням — для графиков и дашбордов.

Параметры:

Параметр	Тип	По умолчанию	Описание
`period`	string	`30d`	Период
`model`	string	—	Фильтр по модели

curl -H "X-API-Key: $KEY" \
  "https://platform.visiobrand.io/api/v1/brands/{id}/trends?period=7d"

Ответ:

{
  "success": true,
  "data": {
    "brandId": "uuid",
    "period": "7d",
    "dataPoints": [
      {
        "date": "2026-03-26",
        "model": "chatgpt",
        "visibility": 15.5,
        "position": 2.3,
        "tests": 45,
        "mentions": 7
      }
    ]
  }
}

GET /brands/:id/sources

Источники, цитируемые AI-платформами — какие сайты нейросети рекомендуют, цитируемость вашего сайта vs конкурентов.

Параметры:

Параметр	Тип	По умолчанию	Описание
`period`	string	`30d`	Период
`model`	string	—	Фильтр по модели

curl -H "X-API-Key: $KEY" \
  "https://platform.visiobrand.io/api/v1/brands/{id}/sources?period=30d"

Ответ:

{
  "success": true,
  "data": {
    "brandId": "uuid",
    "brandWebsite": "visiobrand.io",
    "period": "30d",
    "summary": {
      "totalSources": 45,
      "ownBrandSources": 3,
      "competitorSources": 12,
      "neutralSources": 30,
      "totalBrandMentions": 156
    },
    "topCitedDomains": [
      {
        "domain": "habr.com",
        "type": "neutral",
        "citationCount": 24,
        "qualityScore": 8.2
      },
      {
        "domain": "visiobrand.io",
        "type": "own_brand",
        "citationCount": 12,
        "qualityScore": 9.1
      }
    ],
    "citationTrend": {
      "brand": [
        { "date": "2026-03-03", "citationRate": 10.4 },
        { "date": "2026-03-04", "citationRate": 8.56 }
      ],
      "competitors": [
        {
          "name": "Конкурент A",
          "trend": [
            { "date": "2026-03-03", "citationRate": 15.2 }
          ]
        }
      ]
    },
    "byPrompt": [
      {
        "promptText": "Лучший сервис для мониторинга бренда в AI",
        "sourcesCount": 8,
        "topDomains": ["habr.com", "vc.ru", "visiobrand.io"]
      }
    ]
  }
}

Типы источников (type):

Тип	Описание
`own_brand`	Ваш сайт
`competitor`	Сайт конкурента
`neutral`	Нейтральный источник (СМИ, блоги, форумы)

Примеры интеграций

Python

import requests

API_KEY = "gc_live_your_key_here"
BASE = "https://platform.visiobrand.io/api/v1"
headers = {"X-API-Key": API_KEY}

# Получить видимость
brands = requests.get(f"{BASE}/brands", headers=headers).json()["data"]
brand_id = brands[0]["id"]

visibility = requests.get(
    f"{BASE}/brands/{brand_id}/visibility",
    headers=headers,
    params={"period": "30d"}
).json()["data"]

print(f"Видимость: {visibility['visibility']['current']}%")
print(f"Тренд: {visibility['visibility']['trend']}")

JavaScript

const API_KEY = "gc_live_your_key_here";
const BASE = "https://platform.visiobrand.io/api/v1";

const res = await fetch(`${BASE}/brands`, {
  headers: { "X-API-Key": API_KEY }
});
const { data: brands } = await res.json();

const vis = await fetch(
  `${BASE}/brands/${brands[0].id}/visibility?period=30d`,
  { headers: { "X-API-Key": API_KEY } }
).then(r => r.json());

console.log(`Видимость: ${vis.data.visibility.current}%`);

MCP Server (подключение данных к AI-ассистентам)

VisioBrand предоставляет MCP Server — стандартный протокол для подключения данных к вашим AI-ассистентам. Поддерживается любым инструментом с поддержкой MCP.

Установка

Пример конфигурации (формат зависит от вашего AI-ассистента):

{
  "mcpServers": {
    "visiobrand": {
      "command": "npx",
      "args": ["-y", "@visiobrand/mcp-server"],
      "env": {
        "VISIOBRAND_API_KEY": "gc_live_your_key_here"
      }
    }
  }
}

Использование

Примеры запросов к AI-ассистенту:

«Какая видимость у моего бренда за последний месяц?»
«Сравни мой бренд с конкурентами»
«Покажи тренды видимости за неделю по ChatGPT»
«Какие промпты показывают лучшие результаты?»

Доступные инструменты

Инструмент	Описание
`list_brands`	Список мониторируемых брендов
`get_brand_visibility`	Текущая видимость + тренд
`get_brand_mentions`	Упоминания по AI-платформам
`get_competitor_analysis`	Сравнение с конкурентами
`get_prompt_results`	Промпты и результаты тестов
`get_trends`	Динамика видимости по дням
`get_sources`	Источники и цитируемость — ваш сайт vs конкуренты

Коды ошибок

Код	Описание
`401`	API ключ не передан или недействителен
`403`	Доступ запрещён (IP не в allowlist)
`404`	Бренд не найден или не принадлежит вашей компании
`405`	Метод не поддерживается (API только для чтения — GET)
`429`	Превышен лимит запросов
`500`	Внутренняя ошибка сервера