Back to Node Auth0

Class StatsClient

docs/classes/management.SDK.StatsClient.html

5.9.13.5 KB
Original Source

Class StatsClient

Index

Constructors

constructor

Methods

getActiveUsersCountgetDaily

Properties

_options

Constructors

constructor

new StatsClient(options: BaseClientOptions): StatsClient

Parameters

Returns StatsClient

Methods

getActiveUsersCount

getActiveUsersCount(
requestOptions?: StatsClient.RequestOptions,
): HttpResponsePromise<number>

Retrieve the number of active users that logged in during the last 30 days.

Parameters

Request-specific configuration.

Returns HttpResponsePromise<number>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.stats.getActiveUsersCount()Copy

getDaily

getDaily(
request?: GetDailyStatsRequestParameters,
requestOptions?: StatsClient.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-specific configuration.

Returns HttpResponsePromise<DailyStats[]>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.stats.getDaily({ from: "from", to: "to" })Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods getActiveUsersCountgetDaily Properties _options