Skip to content

Latest commit

 

History

History
83 lines (52 loc) · 3.94 KB

HyperionApiClient--Clients--StatsClient.md

File metadata and controls

83 lines (52 loc) · 3.94 KB
Raw

class HyperionApiClient::Clients::StatsClient

class HyperionApiClient::Clients::StatsClient
  : public ClientExtensions

Summary

Members Descriptions
public string BaseUrl
public StatsClient(HttpClient httpClient)
public async Task< GetActionUsageResponse > GetActionUsageAsync(string period, string endDate, bool? uniqueActors, CancellationToken cancellationToken) = default get action and transaction stats for a given period
public async Task< GetMissedBlocksResponse > GetMissedBlocksAsync(string producer, string after, string before, int? minBlocks, CancellationToken cancellationToken) = default get missed blocks
public async Task< GetResourceUsageResponse > GetResourceUsageAsync(string code, string action, CancellationToken cancellationToken) = default get resource usage stats for a specific action
private readonly HttpClient _httpClient

Members

public string BaseUrl
public StatsClient(HttpClient httpClient)
public async Task< GetActionUsageResponse > GetActionUsageAsync(string period, string endDate, bool? uniqueActors, CancellationToken cancellationToken) = default

get action and transaction stats for a given period

Parameters

  • cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Parameters

  • period analysis period

  • end_date final date

  • unique_actors compute unique actors

Returns

Default Response

Exceptions

  • ApiException A server side error occurred.
public async Task< GetMissedBlocksResponse > GetMissedBlocksAsync(string producer, string after, string before, int? minBlocks, CancellationToken cancellationToken) = default

get missed blocks

Parameters

  • cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Parameters

  • producer filter by producer

  • after filter after specified date (ISO8601)

  • before filter before specified date (ISO8601)

  • min_blocks min. blocks threshold

Exceptions

  • ApiException A server side error occurred.
public async Task< GetResourceUsageResponse > GetResourceUsageAsync(string code, string action, CancellationToken cancellationToken) = default

get resource usage stats for a specific action

Parameters

  • cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Parameters

  • code contract

  • action action name

Returns

Default Response

Exceptions

  • ApiException A server side error occurred.
private readonly HttpClient _httpClient