API v1

A retenção da sua equipe, via API

Puxe retenção, módulos e gaps de conhecimento por HTTP. Conecte ao seu BI, automatize alertas ou licencie os dados — o SYNAPSE também é infraestrutura.

Autenticação

Envie sua chave no header Authorization: Bearer SUA_API_KEY. Solicite uma chave no plano Scale. Endpoints respondem JSON e suportam CORS.

Endpoint

GET/api/v1/retention

Retorna o resumo de retenção da organização.

Exemplos

cURL

curl https://synapse-umber-pi.vercel.app/api/v1/retention \
  -H "Authorization: Bearer SUA_API_KEY"

JavaScript

const res = await fetch(
  "https://synapse-umber-pi.vercel.app/api/v1/retention",
  { headers: { Authorization: "Bearer SUA_API_KEY" } }
);
const { data } = await res.json();
console.log(data.retention.overall_pct); // 78.4

Resposta

{
  "ok": true,
  "version": "1",
  "data": {
    "retention": {
      "overall_pct": 78.4,
      "change_30d": 12.1,
      "modules": [ ... ],
      "gaps": [ { "concept": "Objeções de preço", "error_rate": 0.61 } ]
    }
  }
}

Quer uma chave de API?

A API faz parte do plano Scale. Comece hoje e fale com a gente para liberar seu acesso.

Ver plano Scale