Pular para o conteúdo
MyClinicAPI Docs
GET

/v1/leads/forecast

Previsão de fechamento: leads abertos por mês previsto

Para cada mês (a partir de from, padrão o mês atual no fuso da clínica): quantidade e soma de estimatedValue dos leads abertos (todas as etapas menos Virou paciente e Fora do perfil), por etapa, e os primeiros cartões. Aceita os mesmos filtros da listagem. Leads sem data prevista e com data vencida vêm em noDate e overdue.

Permissão:leads: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

  • qstringOpcional

    Nome, telefone, e-mail, cidade ou origem (código ou rótulo: "insta", "Google", "indicação"). · Até 100 caracteres

  • stagestringOpcional

    Etapas separadas por vírgula: NEW, DISCOVERY, QUALIFIED, READY_TO_SCHEDULE, SCHEDULED, COMPLETED, NURTURE, NOT_A_FIT, HUMAN_HANDOFF.

  • sourcestringOpcional

    Origens separadas por vírgula.

  • channelstringOpcional

    Canais separados por vírgula.

  • servicestringOpcional

    service_keys separados por vírgula.

  • professionalstringOpcional

    professional_keys separados por vírgula.

  • qualifiedbooleanOpcional
  • readybooleanOpcional
  • appointmentstringOpcional

    Valores: agendado, realizado, nenhum

  • ownerTypestringOpcional

    Valores: human, agent

  • ownerstringOpcional

    membership id ou agent_key. · Até 64 caracteres

  • agentstringOpcional

    agent_key da última ação automática. · Até 64 caracteres

  • createdFromstringOpcional

    Formato AAAA-MM-DD

  • createdTostringOpcional

    Formato AAAA-MM-DD

  • periodDaysintegerOpcional

    Atalho: leads criados nos últimos N dias. · Entre 1 e 365

  • labelsstringOpcional

    Ids de etiqueta separados por vírgula: leads com QUALQUER uma delas. · Até 400 caracteres

  • hasValuebooleanOpcional

    true = só leads com valor estimado; false = só sem valor.

  • fromstringOpcional

    Primeiro mês (YYYY-MM). Padrão: mês atual. · Padrão (regex): ^\d{4}-(0[1-9]|1[0-2])$

  • monthsintegerOpcional

    Quantos meses (1–12). · Padrão: 6 · Entre 1 e 12

  • perMonthintegerOpcional

    Cartões por mês (1–50). · Padrão: 10 · Entre 1 e 50

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/leads/forecast", {  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": {    "months": [      {        "month": "2026-10",        "label": "<label>",        "total": 1,        "valueTotal": 1,        "withValue": 1,        "byStage": [          {}        ],        "items": [          {}        ],        "nextCursor": "<nextCursor>"      }    ],    "totals": {      "total": 1,      "valueTotal": 1,      "withValue": 1    },    "overdue": {      "count": 1,      "valueTotal": 1    },    "noDate": {      "count": 1,      "valueTotal": 1    },    "openStages": [      "NEW"    ]  }}

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)