Relatorio de Resumo de Vendas

GET /external/v1/reports/sales-summary

Retorna contagens e valores de abertas / ganhas / perdidas na conta, com filtros opcionais. Usa as mesmas definicoes do CRM do Getraze.

Definicoes

• Aberta = ativa (lost_at IS NULL e discarded_at IS NULL) e nao em etapa de ganho.
• Ganha = ativa e em uma etapa marcada como is_win_stage (a coluna "ganho" do Kanban).
• Perdida = lost_at IS NOT NULL ou discarded_at IS NOT NULL.
• Valores sao a soma crua de opportunities.value (moedas misturadas somadas como estao).

Autenticacao

Requer permissao reports:read.

Parametros de Query

Parametro	Tipo	Padrao	Descricao
pipeline_id	string	-	Restringe a um pipeline
sector_id	string	-	Restringe a um setor/time
owner_user_id	string	-	Restringe a um vendedor
from	string (ISO 8601)	-	Apenas oportunidades criadas a partir desta data
to	string (ISO 8601)	-	Apenas oportunidades criadas ate esta data

Requisicao

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

Resposta

{
  "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"
    }
  }
}

Campos de Resposta

Campo	Tipo	Descricao
open.count / open.value	number	Oportunidades ativas nao-ganhas e a soma do valor
won.count / won.value	number	Oportunidades ganhas e a soma do valor (receita)
lost.count	integer	Oportunidades perdidas/descartadas
total_opportunities	integer	Todas as oportunidades que casam com os filtros
open_pipeline_value	number	Igual a open.value — total do pipeline aberto
avg_ticket	number	won.value / won.count
filters	object	Os filtros aplicados a esta resposta