Get revenue analytics deep-dive
GET
/dashboard/revenue_analytics
Get comprehensive revenue analytics: daily trend, by type, top customers, collection metrics, and net revenue.
Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ”Responses
Section titled “ Responses ”Successful Response
RevenueAnalyticsResponse
object
daily_revenue
required
Daily Revenue
Array<object>
DailyRevenuePointobject
date
required
Date
string
revenue_cents
required
Revenue Cents
number
revenue_by_type
required
Revenue By Type
Array<object>
RevenueByTypeBreakdownobject
invoice_type
required
Invoice Type
string
revenue_cents
required
Revenue Cents
number
count
required
Count
integer
top_customers
required
Top Customers
Array<object>
TopCustomerRevenueobject
customer_id
required
Customer Id
string
customer_name
required
Customer Name
string
revenue_cents
required
Revenue Cents
number
invoice_count
required
Invoice Count
integer
collection
required
CollectionMetrics
object
total_invoiced_cents
required
Total Invoiced Cents
number
total_collected_cents
required
Total Collected Cents
number
collection_rate
required
Collection Rate
number
overdue_count
required
Overdue Count
integer
overdue_amount_cents
required
Overdue Amount Cents
number
net_revenue
required
NetRevenueMetrics
object
gross_revenue_cents
required
Gross Revenue Cents
number
refunds_cents
required
Refunds Cents
number
credit_notes_cents
required
Credit Notes Cents
number
net_revenue_cents
required
Net Revenue Cents
number
currency
required
Currency
string
currency
required
Currency
string
Unauthorized – invalid or missing API key
Validation Error
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context