cURL
curl --request GET \ --url https://api.example.com/v1/ledgers/{id}/analytics \ --header 'Authorization: Bearer <token>'
{ "ledger_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "period": "daily", "metrics": { "average_balance": 123, "min_balance": 123, "max_balance": 123, "total_credits": 123, "total_debits": 123, "transaction_count": 123 }, "trends": [ { "period_start": "2023-11-07T05:31:56Z", "period_end": "2023-11-07T05:31:56Z", "average_balance": 123, "credits": 123, "debits": 123 } ] }
Retrieve analytical data for a ledger
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearer <token>
<token>
Ledger UUID
Analysis period
daily
weekly
monthly
yearly
Start date for analysis
End date for analysis
Analytics data retrieved successfully
Show child attributes