API-пайплайн: визиты проекта и трафик вашего сайта

Индекс: API-пайплайны — индекс

Цель: видеть визиты, которые ваши кампании приводят в проект, и считать визиты на вашем собственном сайте.

Шаги

1. Визиты проекта (его владелец).

GET /v0/my/console/traffic/summary?project=470000000000000001&window_days=30
→ {"timeline": [{"day": "2026-10-14", "visits": 12, "uniques": 9}, …],
   "visits": [{"utm_campaign": "470000000000000061", "utm_source": "telegram", "visits": 8, "uniques": 6}, …],
   "domain": "example.com", "domain_verified": true,
   "snippet_last_visit": "2026-10-15 19:16:04.703", …}

• visits: визиты по кампании (utm_campaign) и источнику (utm_source); пустые строки = напрямую.
• internal: открытия проекта по ссылкам кампаний внутри Cabi.Chat; external: переходы из Cabi.Chat на ваш подтверждённый сайт; totals — сумма обоих.
• domain: хост контакта Website проекта; domain_verified: подтвердили ли вы, что он ваш; snippet_last_visit: последний визит, засчитанный на этом сайте за последние 7 дней.

2. Визиты, которые привела одна кампания.

GET /v0/my/console/traffic/campaign?campaign=470000000000000061
→ {"visits": 14, "uniques": 11, "timeline": […],
   "rows": [{"utm_source": "telegram", "project": "470000000000000001", "visits": 8, "uniques": 6}, …]}

rows: по источнику и проекту, на который попал посетитель.

3. Подтвердить домен.

POST /v0/my/console/domains
{"host": "example.com"}
→ {"host": "example.com", "token": "<token>", "verified": false, …}

Разместите токен одним из трёх способов, затем проверьте:

• DNS-запись TXT cabi-verify=<token> (method: "dns");
• файл https://example.com/cabi-verify-<token>.html, содержимое которого — токен ("html");
• <meta name="cabi-verify" content="<token>" /> в head главной страницы ("meta").

POST /v0/my/console/domains/verify
{"host": "example.com", "method": "meta"}
→ {"verified": true}       or {"verified": false, "reason": "…"}

Ваши домены: GET /v0/my/console/domains; удалить: DELETE /v0/my/console/domains/{host} → 204.

4. Считать визиты на сайте. Добавьте на каждую страницу:

<script async src="https://cabi.chat/cabi.js" data-project="470000000000000001"></script>

Каждый просмотр страницы передаёт путь, referrer и параметры utm_*; скрипт хранит анонимный id посетителя в local storage браузера и не ставит cookies. Когда просмотры начнут приходить, snippet_last_visit обновится, а визиты появятся в шаге 1.

За кадром

• Блок сайта (domain, domain_verified, snippet_last_visit) следует за контактом Website проекта: сначала добавьте его.
• Ссылки с utm_campaign=<campaign nonce> и utm_source засчитываются этой кампании.

Правила

• 400 invalid domain; method must be dns|html|meta.
• 404: не ваш проект, кампания или домен.
• Изменения DNS могут появиться через несколько минут; проверьте снова.

Поверхность API