API Clientes Impulso+

Clínicas ativas, farm (expansão) e atividade de cada usuário do app nas clínicas, numa API só. Uso interno. Versão 1.0.0.

Como chamar

Só GET, com a chave no cabeçalho x-api-chave (ou Authorization: Bearer <chave>). Sem a chave certa, a resposta é 401. A documentação e o /api/v1/openapi.json abrem sem chave.

curl -H "x-api-chave: $CHAVE" https://<este-endereço>/api/v1/resumo

Atualiza sozinha a cada 30 minutos, das 7h às 23h. O horário da leitura vem em gerado_em (São Paulo).

Dado pessoal. A atividade traz o nome de cada usuário do app, que é paciente da clínica. CPF, e-mail e telefone nunca saem: cada usuário tem um código fixo (id). Guarde a chave como senha e use só em sistema interno, servidor para servidor.

Recursos

GET/api/v1/resumo

O geral: total de clínicas e vidas contratadas, o resumo da farm (taxa, vidas e receita de expansão, por mês) e o uso do app (usuários, quantos usaram hoje, em 7 e em 30 dias, quantos nunca usaram).

GET/api/v1/clinicas

Todas as clínicas clientes (Clínicas Ativas do Notion), com o cadastro do admin e o uso do app de cada uma.

ParâmetroO que faz
clinicaParte do nome, sem acento.

Campos

cliente, estagio, responsavel_comercial, inicio, cancelada_em, vidas_contratadas, vidas_ativas_notion, mensalidade, fatura, pagamento, medico, contato (nomes, e-mails e telefones da clínica), admin (licenças, pacientes ativos, pendentes, contrato, renovação, situação) e uso_app (usuários, ativos até 2 dias, hoje, 1–2, 3–6 e 7+ dias, desinstalaram, nunca instalaram).

GET/api/v1/farm

A expansão da base: todas as compras de vidas a mais, desde a primeira, e as novas entram sozinhas a cada atualização. Mesmo cálculo do Painel do Canal Médico.

ParâmetroO que faz
clinicaParte do nome, sem acento.
desdeAAAA-MM-DD: só compras a partir da data.

Campos

resumo (base, quantos expandiram, taxa, vidas no M0 e depois, receita de expansão), por_mes, compras (cliente, quando, mês, vidas, fatura, tipo, lote, responsável), clientes (por clínica: M0, depois, total, quantas vezes, renovações, receita) e cancelados.

GET/api/v1/atividade

Cada usuário do app nas clínicas: em que dias usou, o último acesso, as sessões por dia, e o geral por clínica.

ParâmetroO que faz
clinicaParte do nome, sem acento.
ativos_desdeAAAA-MM-DD: só quem acessou a partir da data.
detalhe=resumidoTira as listas dia a dia, para respostas menores.

Por usuário (usuarios)

id (código fixo), nome, clinica, plano, app_instalado, faixa, primeiro_acesso, ultimo_acesso (dia, São Paulo), ultimo_acesso_em (hora, UTC), dias_sem_acesso, sessoes_total, dias_de_uso (lista de dias), dias_de_uso_7d, dias_de_uso_30d e sessoes_por_dia ({dia: sessões}).

Por clínica (por_clinica)

usuarios, usaram_hoje, usaram_7d, usaram_30d, nunca_usaram, pct_usaram_7d, ultimo_acesso e dias_de_uso_30d_media.

Como o dia de uso é medido. O Engajamento tira uma foto da base várias vezes ao dia. Vale a última foto de cada dia: o dia do "último acesso" nela é um dia de uso, e as sessões do dia são a diferença do contador de sessões para a foto do dia anterior. O histórico começa no primeiro dia com foto (historico_desde). Só entra quem é do grupo Clínica no Engajamento.

De onde vem

Clínicas e farm: o Painel do Canal Médico (Notion Clínicas Ativas, admin de cadastro e as compras de expansão). Atividade: o Engajamento (God Mode e MoEngage). Nada novo é lido com login: a API junta o que esses dois já leem.