Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UserStatisticsDTO

interface

UserStatisticsDTO

description

This interface defines the fields that are returned by the backend runtime using the /statistics/user/:address endpoint.

example

Using the UserStatisticsDTO interface

const statistics = {
address: "...",
period: "20221117",
periodFormat: "D",
position: 1,
amount: 0,
data: {
totalPracticedMinutes: 0,
totalEarned: 0,
}



Properties

param address

Contains the address of the user.

param period

Contains the "date period" of which this entry aggregates data.

param periodFormat

Contains the type of date period used to generate data.

param position

(Optional) Contains a potential leaderboard position.

param amount

(Optional) Contains an amount of tokens earned during said date period.

param data

Contains aggregated data as defined by UserDataAggregateDTO.

since

v0.5.0

Hierarchy

  • UserStatisticsDTO

Index

Properties

address: string
amount?: number
period: string
periodFormat: string
position?: number

Generated using TypeDoc