Class StatsManager

Hierarchy

BaseAPI
- StatsManager

Index

Constructors

Properties

Methods

getActiveUsersCount getDaily request

Constructors

constructor

new StatsManager(configuration): StatsManager
Parameters
- configuration: Configuration
Returns StatsManager
Inherited from BaseAPI.constructor
- Defined in src/lib/runtime.ts:24

Properties

`Protected` configuration

configuration: Configuration

Methods

getActiveUsersCount

getActiveUsersCount(initOverrides?): Promise<ApiResponse<number>>
Retrieve the number of active users that logged in during the last 30 days. Get active users count

Throws
Parameters
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<number>>
- Defined in src/management/__generated/managers/stats-manager.ts:17

getDaily

getDaily(requestParameters?, initOverrides?): Promise<ApiResponse<StatsEntry[]>>
Retrieve the number of logins, signups and breached-password detections (subscription required) that occurred each day within a specified date range. Get daily stats

Throws
Parameters
- requestParameters: GetDailyRequest = {}
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<StatsEntry[]>>
- Defined in src/management/__generated/managers/stats-manager.ts:35

`Protected` request

request(context, initOverrides?): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in src/lib/runtime.ts:40