Pular para o conteúdo
Relatórios

Funil de conversão por etapa

v1.0.0
GEThttps://api.staging.growthaisystem.com/api/v1/reports/funnel
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escoposreports.read

Onde os negócios param. Sem pipelineId, o funil padrão do workspace.

Período: from/to em ISO-8601; sem eles, os últimos 90 dias. Uma chave gos_ vê o workspace inteiro; um token OAuth de pessoa vê só os funis que o papel dela enxerga.

Parâmetros de consulta

Vão na querystring, depois do ?.

  • pipelineIdstringopcional
    • tamanho 1–80
  • fromstringopcional
  • tostringopcional

Respostas

7 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

Cada etapa do funil com quantos negócios ENTRARAM nela no período e quantos desses terminaram ganhos.

V1ReportFunnel

  • pipelineIdstring | null
  • fromstring
  • tostring
  • Cada item da lista

    • stageIdstring
    • namestring
    • kindstring
      • um de"open""won""lost"
    • enteredinteger
    • wonFromHereinteger