REST API → Источники и intents

GET /api/v1/bots/{id}/sources

Сводка по источникам трафика (UTM).

Scope: read

curl "https://capybara.maxbotstat.ru/api/v1/bots/<botId>/sources" \
     -H "X-API-Key: $MBS_KEY"

Ответ

{
  "utm_key": "utm_source",
  "data": [
    { "source_value": "instagram", "campaign_name": "spring", "contacts_count": 412, "touches": 1024 },
    { "source_value": "ads",       "campaign_name": null,     "contacts_count": 88,  "touches": 162 },
    { "source_value": "— unmapped","campaign_name": null,     "contacts_count": 5,   "touches": 12 }
  ]
}

• utm_key — текущий ключ UTM, заданный в настройках бота.
• source_value: "— unmapped" — контакты без /start-параметра.
• touches — суммарное число «касаний» (повторные приходы по одной и той же ссылке).

См. также: Гайд → UTM-источники.

GET /api/v1/bots/{id}/intents

Список intent'ов с метриками.

Scope: read

curl "https://capybara.maxbotstat.ru/api/v1/bots/<botId>/intents" \
     -H "X-API-Key: $MBS_KEY"

Ответ

{
  "data": [
    {
      "id": "67d4...",
      "name": "payment",
      "description": "Вопросы про оплату",
      "color": "#16a34a",
      "is_active": true,
      "users_count": 312,
      "messages_count": 845,
      "created_at": "2025-09-01T10:00:00Z"
    },
    {
      "id": "8b1f...",
      "name": "complaint",
      "description": "Жалобы и недовольство",
      "color": "#dc2626",
      "is_active": true,
      "users_count": 28,
      "messages_count": 67,
      "created_at": "2025-09-15T14:00:00Z"
    }
  ]
}

Поле	Описание
id	публичный UUID intent'а
name	технический ключ
description	человеко-читаемое описание
color	hex-цвет для UI
is_active	если false, intent не применяется к новым сообщениям
users_count	контактов, у которых хоть раз сработал intent
messages_count	сообщений, попавших в intent

Что нельзя через REST API

• Создать/изменить intent. Это делается через приватный API кабинета (POST /api/bots/:id/intents), который требует JWT.
• Получить список сообщений конкретного intent'а. Используйте кабинет или приватный API.

Если нужны эти возможности через REST — пишите в поддержку, добавим в v1.1.

Связь с воронками

Intent'ы — отличный материал для условий этапов воронки. См. Гайд → Воронки.