Cards de aquisição por canal
Um card por canal pago, como Meta Ads e Google Ads, com investimento, novos clientes, CAC, LTV, LTV/CAC, ROI e payback.
Use para comparar canais. Cada métrica traz value e changePct, a variação contra o período anterior de mesma duração.
- O canal
Orgâniconão aparece, porque não tem investimento. - A lista não vem ordenada. Ordene no seu lado, por exemplo por
investment.value. cacconsidera só as campanhas marcadas como aquisição.ltveroiconsideram todos os clientes e todo o investimento do canal.ltvé bruto, sem margem.- Um canal sem dados no período anterior vem com
changePctnull.paybackMonths.changePcté semprenull.
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.
dateCards por canal retornados com sucesso
application/json- response
marginConfigured?booleanIndica se a organização configurou uma margem de contribuição na plataforma. false significa que o padrão de 100% está em uso.
marginCompleteness?MarginCompletenessCompletude da margem de contribuição configurada por itens de custo: complete = todos os itens resolvidos; partial = algum item pendente, então a margem aplicada é parcial; none = sem composição por itens (margem nunca configurada ou configurada como um percentual único; diferencie com marginConfigured).
"complete""partial""none"marginItemStatus?Status por item da composição da margem (synced = vindo dos pedidos, configured = informado pelo usuário, pending = não configurado ou com dados ausentes). null quando a organização não tem composição.
channels*array<>Um card por canal pago, sem ordenação. Lista vazia quando a organização não teve dados de canal pago no período.
hasAcquisitionClassification*booleanO mesmo indicador de /v1/acquisition/summary, com o mesmo valor: se a organização marcou alguma campanha como aquisição.
curl -X GET "https://example.com/v1/acquisition/channels?organizationId=c0ad4763-173e-4a05-9cff-5208c8ea5f6a&period=30d&startDate=2026-03-11&endDate=2026-03-22"{ "channels": [ { "channel": "Meta Ads", "investment": { "value": 128000, "changePct": 9.4 }, "acquisitionInvestment": { "value": 112000, "changePct": 10.7 }, "acquisitionNewCustomers": { "value": 800, "changePct": 4.1 }, "newCustomers": { "value": 1120, "changePct": 3.2 }, "cac": { "value": 140, "changePct": 6.01 }, "ltv": { "value": 486.5, "changePct": -1.2 }, "ltvCacRatio": { "value": 3.48, "changePct": -6.8 }, "paybackMonths": { "value": 2.7, "changePct": null }, "roi": { "value": 1.94, "changePct": 11.3 } }, { "channel": "Google Ads", "investment": { "value": 84000, "changePct": null }, "acquisitionInvestment": { "value": 0, "changePct": null }, "acquisitionNewCustomers": { "value": 0, "changePct": null }, "newCustomers": { "value": 710, "changePct": null }, "cac": { "value": null, "changePct": null }, "ltv": { "value": 512.1, "changePct": null }, "ltvCacRatio": { "value": null, "changePct": null }, "paybackMonths": { "value": null, "changePct": null }, "roi": { "value": 0.87, "changePct": null } } ], "hasAcquisitionClassification": false}