Scorum
Account statistics API

Provide api to get statistics over the time window for a particular account. More...

Public API

statistics scorum::account_statistics::account_statistics_api::get_stats_for_time (const fc::time_point_sec &open, uint32_t interval) const
 Gets statistics over the time window length, interval, that contains time, open. More...
 
statistics scorum::account_statistics::account_statistics_api::get_stats_for_interval (const fc::time_point_sec &start, const fc::time_point_sec &stop) const
 Aggregates statistics over a time interval. More...
 
statistics scorum::account_statistics::account_statistics_api::get_lifetime_stats () const
 Returns lifetime statistics. More...
 
statistics scorum::account_statistics::account_statistics_api::get_stats_for_time_by_account_name (const account_name_type &account_name, const fc::time_point_sec &open, uint32_t interval) const
 
statistics scorum::account_statistics::account_statistics_api::get_stats_for_interval_by_account_name (const account_name_type &account_name, const fc::time_point_sec &start, const fc::time_point_sec &end) const
 
statistics scorum::account_statistics::account_statistics_api::get_lifetime_stats_by_account_name (const account_name_type &account_name) const
 

Detailed Description

Provide api to get statistics over the time window for a particular account.

Require: account_statistics_plugin

Function Documentation

◆ get_lifetime_stats()

statistics scorum::account_statistics::account_statistics_api::get_lifetime_stats ( ) const

Returns lifetime statistics.

Definition at line 40 of file account_statistics_api.cpp.

◆ get_lifetime_stats_by_account_name()

statistics scorum::account_statistics::account_statistics_api::get_lifetime_stats_by_account_name ( const account_name_type account_name) const

Definition at line 68 of file account_statistics_api.cpp.

◆ get_stats_for_interval()

statistics scorum::account_statistics::account_statistics_api::get_stats_for_interval ( const fc::time_point_sec &  start,
const fc::time_point_sec &  stop 
) const

Aggregates statistics over a time interval.

Parameters
startThe beginning time of the window.
stopThe end time of the window. end must take place after start.
Returns
Aggregated statistics over the interval.

Definition at line 33 of file account_statistics_api.cpp.

◆ get_stats_for_interval_by_account_name()

statistics scorum::account_statistics::account_statistics_api::get_stats_for_interval_by_account_name ( const account_name_type account_name,
const fc::time_point_sec &  start,
const fc::time_point_sec &  end 
) const

Definition at line 56 of file account_statistics_api.cpp.

◆ get_stats_for_time()

statistics scorum::account_statistics::account_statistics_api::get_stats_for_time ( const fc::time_point_sec &  open,
uint32_t  interval 
) const

Gets statistics over the time window length, interval, that contains time, open.

Parameters
openThe opening time, or a time contained within the window.
intervalThe size of the window for which statistics were aggregated.
Returns
Statistics for the window.

Definition at line 28 of file account_statistics_api.cpp.

◆ get_stats_for_time_by_account_name()

statistics scorum::account_statistics::account_statistics_api::get_stats_for_time_by_account_name ( const account_name_type account_name,
const fc::time_point_sec &  open,
uint32_t  interval 
) const

Definition at line 45 of file account_statistics_api.cpp.