Options
All
  • Public
  • Public/Protected
  • All
Menu
label

STATISTICS

description

The statistics controller of the app. Handles requests about users that are available in the database.

This controller defines the following routes:

URI HTTP method Class method Description
/statistics/users/:address GET {@link UserController.find} Responds with a pageable PaginatedResultDTO that contains StatisticsDTO objects.


since

v0.5.0

Hierarchy

  • UsersController

Index

Constructors

Methods

Constructors

Methods

  • Requests a user's statistics[TYPE=user] entries. This endpoint is protected and a valid access token must be attached in the Authorization request header, in signed cookies or in browser cookies.

    The request is secured using the AuthGuard guard which attaches a payload to the request object.

    method

    GET

    access

    protected

    async

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

      An express request used to extract the authenticated user payload.

    • query: StatisticsQuery

    Returns Promise<PaginatedResultDTO<StatisticsDTO>>

    An authenticated user's owned assets.

Generated using TypeDoc