StatsApi.md

ledger.StatsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
readStats	GET /{ledger}/stats	Get statistics from a ledger

readStats

StatsResponse readStats()

Get statistics from a ledger. (aggregate metrics on accounts and transactions)

Example

import { ledger } from '@numaryhq/ledger-nodejs';
import * as fs from 'fs';

const configuration = ledger.createConfiguration();
const apiInstance = new ledger.StatsApi(configuration);

let body:ledger.StatsApiReadStatsRequest = {
  // string | name of the ledger
  ledger: "ledger001",
};

apiInstance.readStats(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
ledger	[string]	name of the ledger	defaults to undefined

Return type

StatsResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200	OK	-
0	Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]