Get revenue SaaS metrics
GET https://api.suger.cloud/org/{orgId}/revenue/dashboard/metrics
Return SaaS revenue metrics for the organization over a date range, including ARR, MRR, and the ARR waterfall. Use this to report recurring-revenue KPIs and period-over-period movement.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string | yes | Organization ID |
partner | query | string | no | Channel filter (AWS, AZURE, GCP, STRIPE, or a CRM_* source). Use ALL or omit for every channel. |
startDate | query | string | no | Start of the reporting range (RFC3339 or YYYY-MM-DD); defaults to 12 months before endDate |
endDate | query | string | no | End of the reporting range (RFC3339 or YYYY-MM-DD); must be on or after startDate |
granularity | query | string | no | Period granularity for the trend series (defaults to MONTH) |
allTime | query | boolean | no | Start at the organization's earliest recurring contract |
Responses
200 — OK
Content-Type: application/json · Schema: RevenueDashboardMetricsResponse
RevenueDashboardMetricsResponse fields:
| Field | Type | Required | Description |
|---|---|---|---|
metrics | object | no | |
periods | object | no | |
waterfall | object | no |
400 — Invalid date, date range, or granularity
Content-Type: application/json
401 — Missing or invalid access token, or the caller lacks the revenue read permission
Content-Type: application/json
500 — Failed to calculate metrics
Content-Type: application/json
View as Markdown · Interactive API reference
Spotted something wrong or out of date on this page? Tell us and we'll correct it.