Funnel Report

GET /external/v1/reports/funnel

Returns the commercial funnel for each pipeline: per-stage count and value of active opportunities, plus the lost count. These are the same numbers shown on the GetRaze CRM Kanban.

Definitions

• Active opportunity = lost_at IS NULL and discarded_at IS NULL. Only active opportunities are counted/summed per stage.
• Lost = lost_at IS NOT NULL or discarded_at IS NOT NULL (returned as lost_count).
• value is the raw sum of opportunities.value (mixed currencies are summed as-is). Filter by a single pipeline/currency upstream if you need a currency-pure figure.
• conversion_from_previous is a snapshot ratio between consecutive stages (current stage count / previous stage count), not a cohort conversion.

Authentication

Requires reports:read permission.

Query Parameters

Parameter	Type	Default	Description
pipeline_id	string	-	Restrict to a single pipeline (otherwise all pipelines are returned)
sector_id	string	-	Restrict to opportunities of a sector/team

Request

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())

Response

{
  "success": true,
  "data": [
    {
      "pipeline_id": "pipe_01",
      "pipeline_name": "Sales",
      "lost_count": 22,
      "stages": [
        {
          "stage_id": "stg_new",
          "stage_name": "New",
          "position": 0,
          "is_won_stage": false,
          "is_loss_stage": false,
          "count": 120,
          "value": 0,
          "conversion_from_previous": null
        },
        {
          "stage_id": "stg_qualified",
          "stage_name": "Qualified",
          "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": "Won",
          "position": 5,
          "is_won_stage": true,
          "is_loss_stage": false,
          "count": 18,
          "value": 270000.00,
          "conversion_from_previous": 25.00
        }
      ]
    }
  ]
}

Response Fields

Field	Type	Description
pipeline_id / pipeline_name	string	Pipeline
lost_count	integer	Lost/discarded opportunities in the pipeline
stages[].count	integer	Active opportunities currently in the stage
stages[].value	number	Sum of value of those active opportunities
stages[].is_won_stage / is_loss_stage	boolean	Stage flags
stages[].conversion_from_previous	number	Snapshot ratio vs the previous stage (%) (null for the first stage)