Pular para o conteúdo
MyClinicAPI Docs
PUT

/v1/reports/kpis/goals/{kpi}

Definir a meta de um KPI da clínica

Meta mensal (KPIs de soma/contagem, ex.: faturamento, sessões) ou nível-alvo (taxas e médias, ex.: ocupação 85%). A meta de faturamento é a mesma da "meta de receita mensal" do Financeiro. Financeiras exigem também reports:finance.

Permissão:reports:readclinic:write

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 caminho

  • kpistringObrigatório

    Chave do KPI. · Valores: faturamento, recebido, aReceber, ticketMedio, sessoesRealizadas, ocupacao, faltas, cancelamentos, novosPacientes, pacientesAtendidos, retorno, leads, conversao, tempoResposta, atendimentosAgentes, resolvidasAgentes

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}$

Corpo da requisição

application/json · obrigatório

  • targetnumberObrigatório

    Meta na unidade do KPI (reais, contagem mensal, % 0–100 ou minutos). · Maior que 0

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/kpis/goals/<kpi>", {  method: "PUT",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "Content-Type": "application/json",  },  body: JSON.stringify({    "target": 1  }),})​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": {}}

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)