API Reference

Transactions Summary

get
{base_url}/api/distributor/v1/dashboard/transactions_summary

Returns aggregate transaction KPIs (total_amount, transaction_count, distinct_cardholder_count) over a configurable time window. Supports period vocabulary (day/week/month/quarter/year/all) and arbitrary from/to date ranges. When both are provided, from/to takes precedence.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uuid

Narrow to a single distributor (Marketer UUID).

uuid

Narrow to a single distributor card (MarketerCard UUID).

string
enum
Defaults to all

Time window for aggregates.

Allowed:
date

Start date (YYYY-MM-DD). Takes precedence over period.

date

End date (YYYY-MM-DD). Takes precedence over period.

Responses

400

rejects unknown period

401

unauthorized request

403

forbidden request

Updated about 2 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?