Funil de fluxo de ganho
Volume de cada etapa do funil configurado pela organização, da exposição à retenção, com a proporção entre as etapas.
- Só voltam as etapas configuradas na plataforma V4MOS.AI, ordenadas por
stageOrder, que pode ter saltos. Sem etapas configuradas, ou sem nenhuma etapa mensurável, a resposta éstages: []. counté volume de eventos somado entre as ferramentas conectadas, não pessoas distintas: impressões (EXPOSURE); cliques e sessões (ATTENTION); leads e adições ao carrinho (INTEREST); MQLs e checkouts iniciados (QUALIFICATION); reuniões, propostas, dados de cliente e checkouts concluídos (COMMITMENT); vendas ganhas no CRM e pedidos pagos (DECISION); recompras (RETENTION).scale: "media"marca as etapas de mídia (EXPOSURE,ATTENTION); as demais sãocustomer. A passagem entre os dois grupos é uma troca de unidade, não uma taxa de conversão.- O nome de exibição da etapa não é retornado: use
stageId.sourceindica as ferramentas que geraram o valor. pctOfFirstepctOfPreviousvêm0(e nãonull) quando a etapa de referência tem contagem zero.
ClientIdAuthClientSecretAuthx-client-id<token>Client ID
x-client-secret<token>Client secret
organizationId*stringIdentificador da organização (obrigatório). Um valor ausente ou que não seja string resulta em 400.
period?stringDescontinuadoDescontinuado: use startDate e endDate, que têm precedência quando enviados. Período relativo de N dias terminando hoje, inclusive (7d = hoje e os 6 dias anteriores). "Hoje" é o dia de calendário em UTC, e esse último dia ainda está parcial. Valores aceitos: 7d, 30d, 90d, 1y. Omitido ou vazio equivale a 30d; qualquer outro valor retorna 400.
"30d""7d""30d""90d""1y"startDate?stringInício do período (YYYY-MM-DD, inclusivo). Envie junto com endDate: enviar só um dos dois retorna 400. Tem precedência sobre period. Use só a data: data com hora ou data inexistente retorna 400. Regras: startDate ≤ endDate, nenhuma data no futuro (UTC) e no máximo 365 dias entre as datas (até 366 dias no período). A comparação usa o período de mesma duração imediatamente anterior.
dateendDate?stringFim do período (YYYY-MM-DD, inclusivo). Veja startDate para as regras. Quando o fim é hoje, esse último dia ainda está parcial, porque os dados do dia continuam chegando.
dateFunil retornado com sucesso
application/json- response
stages*array<>Só as etapas configuradas pela organização, ordenadas por stageOrder. Lista vazia quando nenhuma etapa do funil foi configurada ou quando nenhuma etapa pôde ser medida.
curl -X GET "https://example.com/v1/acquisition/funnel?organizationId=c0ad4763-173e-4a05-9cff-5208c8ea5f6a&period=30d&startDate=2026-03-11&endDate=2026-03-22"{ "stages": [ { "stageId": "EXPOSURE", "stageOrder": 1, "count": 1250000, "pctOfFirst": 100, "pctOfPrevious": 100, "previousCount": 1250000, "scale": "media", "source": { "tools": [ "META_ADS", "GOOGLE_ADS" ], "fields": [ "impressions", "impressions" ], "resolution": "sum", "label": "Meta Ads · Impressões + Google Ads · Impressões" }, "frequency": 3.33 }, { "stageId": "ATTENTION", "stageOrder": 2, "count": 18750, "pctOfFirst": 1.5, "pctOfPrevious": 1.5, "previousCount": 1250000, "scale": "media", "source": { "tools": [ "GA4" ], "fields": [ "session_start" ], "resolution": "single", "label": "GA4 · Sessões" } }, { "stageId": "QUALIFICATION", "stageOrder": 4, "count": 2100, "pctOfFirst": 0.17, "pctOfPrevious": 11.2, "previousCount": 18750, "scale": "customer", "source": { "tools": [ "GA4" ], "fields": [ "begin_checkout" ], "resolution": "single", "label": "GA4 · Initiate checkout" } }, { "stageId": "DECISION", "stageOrder": 6, "count": 420, "pctOfFirst": 0.03, "pctOfPrevious": 20, "previousCount": 2100, "scale": "customer", "source": { "tools": [ "VTEX" ], "fields": [ "orders_paid" ], "resolution": "single", "label": "VTEX · Pedido pago" } }, { "stageId": "RETENTION", "stageOrder": 7, "count": 63, "pctOfFirst": 0.01, "pctOfPrevious": 15, "previousCount": 420, "scale": "customer", "source": { "tools": [ "VTEX" ], "fields": [ "repurchase" ], "resolution": "single", "label": "VTEX · Recompra" } } ]}