Class Stats

Index

Constructors

Methods

getActiveUsersCount getDaily _getAuthorizationHeader

Properties

Constructors

constructor

new Stats(_options: Stats.Options): Stats
Parameters
- _options: Stats.Options
Returns Stats

Methods

getActiveUsersCount

getActiveUsersCount(
requestOptions?: Stats.RequestOptions,
): HttpResponsePromise<number>
Retrieve the number of active users that logged in during the last 30 days.
Parameters
- OptionalrequestOptions: Stats.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<number>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.stats.getActiveUsersCount()
```

getDaily

getDaily(
request?: Management.GetDailyStatsRequestParameters,
requestOptions?: Stats.RequestOptions,
): HttpResponsePromise<DailyStats[]>
Retrieve the number of logins, signups and breached-password detections (subscription required) that occurred each day within a specified date range.
Parameters
- request: Management.GetDailyStatsRequestParameters = {}
- OptionalrequestOptions: Stats.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<DailyStats[]>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.stats.getDaily()
```

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: Stats.Options