Pipeline de API: visitas del proyecto y tráfico de tu sitio web
Índice: Pipelines de API — índice
Objetivo: ver las visitas que tus campañas traen a tu proyecto y contar las visitas de tu propio sitio web.
Pasos
- Visitas a un proyecto (su dueño).
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: visitas por campaña (utm_campaign) y fuente (utm_source); cadenas vacías = directo.internal: aperturas del proyecto desde enlaces de campaña dentro de Cabi.Chat;external: clics desde Cabi.Chat a tu sitio verificado;totalssuma ambos.domain: el host del contacto Website del proyecto;domain_verified: si demostraste que es tuyo;snippet_last_visit: la última visita contada en ese sitio en los últimos 7 días.
- Visitas que trajo una campaña.
GET /v0/my/console/traffic/campaign?campaign=470000000000000061
→ {"visits": 14, "uniques": 11, "timeline": […],
"rows": [{"utm_source": "telegram", "project": "470000000000000001", "visits": 8, "uniques": 6}, …]}
rows: por fuente y por el proyecto al que llegó el visitante.
- Verificar tu dominio.
POST /v0/my/console/domains
{"host": "example.com"}
→ {"host": "example.com", "token": "<token>", "verified": false, …}
Coloca el token de una de estas tres formas y luego comprueba:
- registro DNS TXT
cabi-verify=<token>(method: "dns"); - un archivo en
https://example.com/cabi-verify-<token>.htmlcuyo contenido es el token ("html"); <meta name="cabi-verify" content="<token>" />en el head de la página principal ("meta").
POST /v0/my/console/domains/verify
{"host": "example.com", "method": "meta"}
→ {"verified": true} or {"verified": false, "reason": "…"}
Tus dominios: GET /v0/my/console/domains; quitar uno: DELETE /v0/my/console/domains/{host} → 204.
- Contar visitas en tu sitio. Añade a cada página:
<script async src="https://cabi.chat/cabi.js" data-project="470000000000000001"></script>
Cada vista de página envía la ruta, el referrer y los parámetros utm_*; el script guarda un id anónimo del visitante en el local storage del navegador y no usa cookies. Cuando lleguen vistas, snippet_last_visit se actualiza y las visitas aparecen en el paso 1.
En segundo plano
- El bloque del sitio web (
domain,domain_verified,snippet_last_visit) sigue al contacto Website del proyecto: añádelo primero. - Los enlaces con
utm_campaign=<campaign nonce>yutm_sourcese atribuyen a esa campaña.
Reglas
- 400
invalid domain;method must be dns|html|meta. - 404: no es tu proyecto, campaña o dominio.
- Los cambios de DNS pueden tardar unos minutos; vuelve a verificar.
Superficie de la API
| Endpoint | Para qué | FE | IA / oráculo |
|---|---|---|---|
GET /v0/my/console/traffic/summary |
Visitas del proyecto, estado de tu sitio | sí (Ver rendimiento) | sí |
GET /v0/my/console/traffic/campaign |
Visitas que trajo una campaña | sí (rendimiento de la campaña) | sí |
POST /v0/my/console/domains |
Obtener un token de verificación | sí | sí |
POST /v0/my/console/domains/verify |
Comprobar el token | sí (Verificar) | sí |
GET / DELETE /v0/my/console/domains |
Listar / quitar dominios | no | sí |