SYSLED DevelopersTodos os métodos
POST

marketing.funnel

Agrega leads de mídia paga, oportunidades e vendas por dia em um funil, incluindo dias sem atividade e fotografia atual de oportunidades paradas.

Grupo: MarketingRevisão: Escopo recomendado: marketing.funnel
Exemplos seguros e fictícios. O domínio example.invalid e a credencial demonstrativa abaixo não funcionam. Use o token real somente no servidor da sua integração e nunca o inclua em páginas públicas.

Parâmetros

Parâmetros aceitos por marketing.funnel
CampoTipoObrigatoriedadeDescriçãoExemplo fictício
fromstring (YYYY-MM-DD)ObrigatórioData inicial inclusiva."2026-09-18"
tostring (YYYY-MM-DD)ObrigatórioData final inclusiva. Intervalo de 1 a 92 dias."2026-09-18"
pipeline_idintegerObrigatórioID positivo do funil acessível à empresa.1

Exemplos fictícios

Os exemplos documentam o formato; eles não executam nenhuma operação.

Requisição

cURL demonstrativo
curl --request POST \
  'https://example.invalid/api/v1/CREDENCIAL_FICTICIA_SEM_VALOR/marketing.funnel' \
  --header 'Content-Type: application/json' \
  --data '{"from":"2026-09-18","to":"2026-09-18","pipeline_id":1}'
Corpo JSON
{
  "from": "2026-09-18",
  "to": "2026-09-18",
  "pipeline_id": 1
}
Resposta HTTP 200
{
  "ok": true,
  "method": "marketing.funnel",
  "result": {
    "company_id": "44444444-4444-4444-8444-444444444444",
    "from": "2026-09-18",
    "to": "2026-09-18",
    "generated_at": "2026-09-18T15:00:00.000Z",
    "days": [
      {
        "date": "2026-09-18",
        "leads": {
          "total": 0,
          "google": 0,
          "meta": 0,
          "other": 0,
          "junk": 0,
          "junk_by_reason": []
        },
        "opportunities": {
          "created": 0,
          "value": 0,
          "by_channel": [],
          "by_pipeline": []
        },
        "sales": {
          "won": 0,
          "value": 0,
          "by_channel": [],
          "by_pipeline": [],
          "lost": 0,
          "lost_by_reason": []
        }
      }
    ],
    "stalled": {
      "snapshot_date": "2026-09-18",
      "buckets": [
        {
          "label": "Mais de 15 dias",
          "count": 0,
          "value": 0
        },
        {
          "label": "11 a 15 dias",
          "count": 0,
          "value": 0
        },
        {
          "label": "8 a 10 dias",
          "count": 0,
          "value": 0
        },
        {
          "label": "4 a 7 dias",
          "count": 0,
          "value": 0
        },
        {
          "label": "Até 3 dias",
          "count": 0,
          "value": 0
        }
      ]
    },
    "pipelines": [
      {
        "id": 1,
        "name": "Funil de exemplo"
      }
    ]
  }
}

Erros

Condições de erro específicas de marketing.funnel
HTTPCódigoCondição
400INVALID_DATE_RANGEDatas ausentes/inválidas ou intervalo fora de 1 a 92 dias.
400PIPELINE_ID_REQUIREDpipeline_id ausente ou não inteiro positivo.
400PIPELINE_NOT_FOUNDFunil não encontrado para a empresa.
403TOKEN_NO_COMPANYToken sem empresa associada.

Consulte também os erros globais e limites.

Observações