Relatorio de Funil

GET /external/v1/reports/funnel

Retorna o funil comercial de cada pipeline: contagem e valor por etapa das oportunidades ativas, mais a contagem de perdidas. Sao os mesmos numeros exibidos no Kanban do CRM do Getraze.

Definicoes

• Oportunidade ativa = lost_at IS NULL e discarded_at IS NULL. Apenas ativas sao contadas/somadas por etapa.
• Perdida = lost_at IS NOT NULL ou discarded_at IS NOT NULL (retornado como lost_count).
• value e a soma crua de opportunities.value (moedas misturadas sao somadas como estao). Filtre por um pipeline/moeda unica se precisar de um valor puro por moeda.
• conversion_from_previous e uma razao instantanea entre etapas consecutivas (contagem da etapa atual / contagem da etapa anterior), nao uma conversao por coorte.

Autenticacao

Requer permissao reports:read.

Parametros de Query

Parametro	Tipo	Padrao	Descricao
pipeline_id	string	-	Restringe a um unico pipeline (caso contrario, todos sao retornados)
sector_id	string	-	Restringe a oportunidades de um setor/time

Requisicao

cURL

curl --request GET \
  --url "https://app.getraze.com/external/v1/reports/funnel?pipeline_id=pipe_01" \
  --header "X-API-Key: YOUR_API_KEY"

Node.js

const axios = require('axios');

const response = await axios.get('https://app.getraze.com/external/v1/reports/funnel', {
  headers: { 'X-API-Key': 'YOUR_API_KEY' },
  params: { pipeline_id: 'pipe_01' }
});

console.log(response.data);

Python

import requests

response = requests.get(
    'https://app.getraze.com/external/v1/reports/funnel',
    headers={'X-API-Key': 'YOUR_API_KEY'},
    params={'pipeline_id': 'pipe_01'}
)

print(response.json())

Resposta

{
  "success": true,
  "data": [
    {
      "pipeline_id": "pipe_01",
      "pipeline_name": "Vendas",
      "lost_count": 22,
      "stages": [
        {
          "stage_id": "stg_new",
          "stage_name": "Novo",
          "position": 0,
          "is_won_stage": false,
          "is_loss_stage": false,
          "count": 120,
          "value": 0,
          "conversion_from_previous": null
        },
        {
          "stage_id": "stg_qualified",
          "stage_name": "Qualificado",
          "position": 1,
          "is_won_stage": false,
          "is_loss_stage": false,
          "count": 72,
          "value": 360000.00,
          "conversion_from_previous": 60.00
        },
        {
          "stage_id": "stg_won",
          "stage_name": "Ganho",
          "position": 5,
          "is_won_stage": true,
          "is_loss_stage": false,
          "count": 18,
          "value": 270000.00,
          "conversion_from_previous": 25.00
        }
      ]
    }
  ]
}

Campos de Resposta

Campo	Tipo	Descricao
pipeline_id / pipeline_name	string	Pipeline
lost_count	integer	Oportunidades perdidas/descartadas no pipeline
stages[].count	integer	Oportunidades ativas atualmente na etapa
stages[].value	number	Soma de value dessas oportunidades ativas
stages[].is_won_stage / is_loss_stage	boolean	Flags da etapa
stages[].conversion_from_previous	number	Razao instantanea vs a etapa anterior (%) (null na primeira etapa)