Skip to main content

Dashboard

Endpoint reference: ✅ Verified live against production on 10 May 2026. Two endpoints power the holder’s headline dashboard: a static counter snapshot, and a date-ranged time-series for charts.

Endpoints


GET /dapp/dashboard/summary — counter snapshot

The headline numbers for a holder’s home page. Cheap call, no params.

Canonical payload

{}

Response shape (verified)

⚠️ profitRecieved is misspelled in the API. It’s missing the second e — should be profitReceived but the production API returns profitRecieved. Do not auto-correct in your code or you’ll silently get undefined. Document the field as-is in your TypeScript types:
🪲 estimateProfit and totalProfit are equal in the verified data. Backend likely treats them as separate concepts (e.g. estimate includes deductions / pending) but the values match in practice. Use totalProfit for display.
🪲 profitRecieved: 0 when no payouts have occurred. Use this to show “X% of your earnings paid out” — (profitRecieved / totalProfit) * 100.

Worked example (Python)


GET /dapp/dashboard/analytics — time-series

Returns a [{name, value, date}] array suitable for a line or bar chart. Choose what to plot via filterBy.

Required query parameters

🪲 Date format mismatch. This endpoint requires ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ); the chart endpoints on individual resources (/dapp/orders/chart-data etc.) use plain YYYY-MM-DD. Two formats in the same API. Mind it.

Error if missing or wrong (verified)

Canonical payload

urlencode(query) — e.g. startDate=2026-04-10T00:00:00.000Z&endDate=2026-05-10T23:59:59.999Z&filterBy=Order

Response shape (verified)

A flat array, no envelope wrapper at the data level — data is the array itself, not { analytics: [...] }.
For filterBy=Profit, value is in USD (e.g. 66 = $66 profit on that day). For filterBy=Client, value is the count of clients created that day. For filterBy=Order, value is the count of orders placed that day.
🪲 name is the weekday name, not the date. If your chart spans more than 7 days, you’ll see repeated names (Monday, Monday, Monday). Always use date for the X-axis, not name. name is presumably for a “this week” view but isn’t very useful otherwise.
⚠️ Empty days are not returned. If no clients/orders/profit on a day, that day is missing from the array. To render a continuous chart, fill gaps client-side:

Worked example (cURL)


Common patterns

Holder’s home dashboard

Combine the summary endpoint with a 30-day analytics chart:

Don’t render profitRecieved in account ledgers

It’s a snapshot of cumulative payouts, not a transaction list. For an actual ledger, use /dapp/commissions?paymentStatus=PAID.

Caching guidance


See also

  • Commissions — payout detail behind profitRecieved
  • Orders — driver of orderCount and totalProfit
  • Clients — driver of clientCount