Skip to content
BoxBilling

Get revenue analytics

GET
/dashboard/revenue

Get revenue analytics: MRR, total this month, outstanding, overdue, and trend.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
start_date
Any of:
string format: date

Period start date (YYYY-MM-DD)

end_date
Any of:
string format: date

Period end date (YYYY-MM-DD)

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

RevenueResponse
object
mrr_cents
required
Mrr Cents
number
total_revenue_this_month_cents
required
Total Revenue This Month Cents
number
outstanding_invoices_cents
required
Outstanding Invoices Cents
number
overdue_amount_cents
required
Overdue Amount Cents
number
currency
required
Currency
string
monthly_trend
required
Monthly Trend
Array<object>
RevenueDataPoint
object
month
required
Month
string
revenue_cents
required
Revenue Cents
number
mrr_trend
Any of:
TrendIndicator
object
previous_value
required
Previous Value
number
change_percent
required
Any of:
number

401

Section titled “401 ”

Unauthorized – invalid or missing API key

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object