v2

latestOpenAPI 3.0.0raw.githubusercontent.com2026-02-16143114179.4 KB

Analytics

Get revenue analytics

Retrieve revenue metrics including total revenue, MRR (monthly recurring revenue), and revenue breakdown by period. Supports filtering by date range and currency.

get/api/analytics/revenue

Query parameters

dateFromstring

Example:2025-01-01

dateTostring

Example:2025-12-31

currencystring

groupBy'day' | 'week' | 'month'

Response

Revenue metrics and breakdown

totalRevenuestring required

Total revenue as decimal string

invoiceCountnumber required

mrrstring required

Monthly recurring revenue

arrstring required

Annual recurring revenue

Example response

{
  "totalRevenue": "12500.0000",
  "invoiceCount": 45,
  "mrr": "4200.0000",
  "arr": "50400.0000"
}