Skip to content

Get Dashboard Summary

GET
/api/Dashboard/summary
curl --request GET \
--url https://example.com/api/Dashboard/summary \
--header 'Authorization: Bearer <token>'

Returns the KPI tiles shown at the top of the dashboard: monthly revenue, active members, processing amount, top product.

MerchantId
string format: uuid

Dashboard KPIs.

Media type application/json
object
monthlyRevenue
number format: double
activeMembers
integer format: int32
processingAmount
number format: double
topProductName
string
nullable
topProductSubscriberCount
integer format: int32
currency
string
nullable
Example generated
{
"monthlyRevenue": 1,
"activeMembers": 1,
"processingAmount": 1,
"topProductName": "example",
"topProductSubscriberCount": 1,
"currency": "example"
}