Skip to content

Get dashboard statistics

GET
/dashboard/stats

Get dashboard statistics.

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)

Successful Response

DashboardStatsResponse
object
total_customers
required
Total Customers
integer
active_subscriptions
required
Active Subscriptions
integer
monthly_recurring_revenue
required
Monthly Recurring Revenue
number
total_invoiced
required
Total Invoiced
number
total_wallet_credits
required
Total Wallet Credits
number
currency
required
Currency
string

Unauthorized – invalid or missing API key

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