Sales Summary Report

GET /external/v1/reports/sales-summary

Returns open / won / lost counts and values across the account, with optional filters. Uses the same definitions as the GetRaze CRM.

Definitions

• Open = active (lost_at IS NULL and discarded_at IS NULL) and not in a won stage.
• Won = active and in a stage flagged is_win_stage (the Kanban "won" column).
• Lost = lost_at IS NOT NULL or discarded_at IS NOT NULL.
• Values are the raw sum of opportunities.value (mixed currencies summed as-is).

Authentication

Requires reports:read permission.

Query Parameters

Parameter	Type	Default	Description
pipeline_id	string	-	Restrict to a pipeline
sector_id	string	-	Restrict to a sector/team
owner_user_id	string	-	Restrict to a seller
from	string (ISO 8601)	-	Only opportunities created on/after this date
to	string (ISO 8601)	-	Only opportunities created on/before this date

Request

cURL

curl --request GET \
  --url "https://app.getraze.com/external/v1/reports/sales-summary?from=2026-01-01&to=2026-01-31" \
  --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/sales-summary', {
  headers: { 'X-API-Key': 'YOUR_API_KEY' },
  params: { from: '2026-01-01', to: '2026-01-31' }
});

console.log(response.data);

Python

import requests

response = requests.get(
    'https://app.getraze.com/external/v1/reports/sales-summary',
    headers={'X-API-Key': 'YOUR_API_KEY'},
    params={'from': '2026-01-01', 'to': '2026-01-31'}
)

print(response.json())

Response

{
  "success": true,
  "data": {
    "open": { "count": 88, "value": 850000.00 },
    "won": { "count": 45, "value": 675000.00 },
    "lost": { "count": 22 },
    "total_opportunities": 155,
    "open_pipeline_value": 850000.00,
    "avg_ticket": 15000.00,
    "filters": {
      "pipeline_id": null,
      "sector_id": null,
      "owner_user_id": null,
      "from": "2026-01-01",
      "to": "2026-01-31"
    }
  }
}

Response Fields

Field	Type	Description
open.count / open.value	number	Active, non-won opportunities and their summed value
won.count / won.value	number	Won opportunities and their summed value (revenue)
lost.count	integer	Lost/discarded opportunities
total_opportunities	integer	All opportunities matching the filters
open_pipeline_value	number	Same as open.value — the open pipeline total
avg_ticket	number	won.value / won.count
filters	object	The filters applied to this response