Pular para o conteúdo
Funil

Resumo do funil (contagem e soma por estágio e por status)

v1.0.0
GEThttps://api.growthaisystem.com/api/v1/opportunities/summary
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escoposopportunities.read

from/to (ISO-8601) recortam por data de criação, intervalo [from, to): total, byStage e byStatus contam os negócios CRIADOS no recorte. closedInRange conta os fechados DENTRO do recorte por wonAt/lostAt, independente de quando foram criados. Sem from/to = tudo. Negócios na lixeira ficam de fora.

Parâmetros de consulta

Vão na querystring, depois do ?.

  • pipelineIdstringopcional
  • fromstringopcional
  • tostringopcional

Respostas

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

200Deu certoapplication/json

Contagem e soma de valores dos negócios CRIADOS no recorte, quebradas por estágio e por status, mais os fechados DENTRO do recorte (closedInRange). Workspace sem negócio devolve os baldes zerados, não 404.

V1OpportunitySummary

  • pipelineIdstring | null
  • fromstring | null
  • tostring | null
    • countinteger
    • valueCentsinteger

  • Cada item da lista

    • countinteger
    • valueCentsinteger
    • stageIdstring

  • Cada item da lista

    • countinteger
    • valueCentsinteger
    • statusstring
      • countinteger
      • valueCentsinteger
      • countinteger
      • valueCentsinteger