GET
/
v1
/
ledgers
/
{id}
/
analytics
{
  "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
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

Ledger UUID

Query Parameters

​
period
enum<string>
default:monthly

Analysis period

Available options:
daily,
weekly,
monthly,
yearly
​
from_date
string<date-time>

Start date for analysis

​
to_date
string<date-time>

End date for analysis

Response

200 - application/json

Analytics data retrieved successfully

The response is of type object.