Pular para o conteúdo
MyClinicAPI Docs
GET

/v1/reports/overview

Aba "Visão geral"

Permissão:reports:read

Autenticação

Envie o token de acesso do usuário no cabeçalho Authorization e, se ele tiver mais de uma clínica, o X-Clinic-Id. Integrações servidor a servidor usam o token de serviço com X-Clinic-Id e X-Agent-Key. Como autenticar

Authorization: Bearer <TOKEN>X-Clinic-Id: <clinic_id>

Parâmetros

Parâmetros de consulta

  • fromstringOpcional

    Padrão: 1º dia do mês corrente. · Formato AAAA-MM-DD

  • tostringOpcional

    Padrão: hoje. · Formato AAAA-MM-DD

Cabeçalhos

  • X-Clinic-IdstringOpcional

    Clínica ativa. Obrigatório só para quem tem acesso a mais de uma clínica (ou token de serviço). Validado contra o vínculo do usuário. · Padrão (regex): ^[A-Za-z0-9._-]{1,64}$

Exemplo de requisição

Gerado do contrato. Troque os marcadores entre < > pelos seus valores.

const res = await fetch("https://myclinc.leadpoint.com.br/v1/reports/overview", {  method: "GET",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",  },})​if (!res.ok) {  const { error } = await res.json()  throw new Error(`${error.code}: ${error.message} (${error.requestId})`)}const { data } = await res.json()

Resposta

200OK — Sucesso.
JSON
{  "data": {    "period": {      "from": "2026-09-18",      "to": "2026-09-18"    },    "kpis": {      "pacientes": 1,      "consultas": 1,      "receita": 1,      "retorno": 1    },    "evolucaoMensal": [      {        "periodo": "<periodo>",        "consultas": 1,        "pacientes": 1      }    ],    "evolucaoSemanal": [      {        "periodo": "<periodo>",        "consultas": 1,        "pacientes": 1      }    ],    "distribuicaoServicos": [      {        "label": "<label>",        "value": 1      }    ],    "principaisServicos": [      {        "servico": "<servico>",        "serviceKey": "<serviceKey>",        "consultas": 1,        "receita": 1      }    ],    "canaisOrigem": [      {        "label": "<label>",        "value": 1      }    ],    "canaisOrigemLeads": [      {        "label": "<label>",        "value": 1      }    ],    "monthlyRevenueGoal": 1  }}

Exemplo gerado do esquema da resposta; valores entre < > são ilustrativos.

Códigos de erro

Corpo no formato padrão { error: { code, message, requestId } }. Veja todos os códigos.

400

Bad Request — Requisição malformada (JSON inválido, cursor inválido ou clínica ativa não informada).

401

Unauthorized — Token ausente, inválido ou expirado.

403

Forbidden — Autenticado, mas sem permissão (perfil ou clínica).

422

Unprocessable Entity — Dados semanticamente inválidos (erros por campo em details).

429

Too Many Requests — Limite de requisições excedido (veja Retry-After).

500

Internal Server Error — Erro interno (sem detalhes expostos).

503

Service Unavailable — Banco de dados indisponível ou não configurado.

Limites

Limite padrão: 120 requisições a cada 60 segundos por token. Sobre limites

Testar no Swagger(abre em nova aba)