Skip to content

OverviewResult

Defined in: packages/client/src/results.ts:293

Answer to an overview query.

app: { id: string; mode: "privacy" | "audit"; name: string; rawRetentionDays: number; saltPeriod: "day" | "week" | "month"; timezone: string; } | null

Defined in: packages/client/src/results.ts:294


appInfo: { approxGuilds: number | null; approxUserAuthorizations: number | null; approxUserInstalls: number | null; eventWebhooksStatus: number | null; libVersion: string | null; name: string; nodeVersion: string | null; release: string | null; sdkVersion: string | null; sessionStartRemaining: number | null; sessionStartTotal: number | null; ts: string; } | null

Defined in: packages/client/src/results.ts:303

What the bot last reported about its application. null until it has.

{ approxGuilds: number | null; approxUserAuthorizations: number | null; approxUserInstalls: number | null; eventWebhooksStatus: number | null; libVersion: string | null; name: string; nodeVersion: string | null; release: string | null; sdkVersion: string | null; sessionStartRemaining: number | null; sessionStartTotal: number | null; ts: string; }

approxGuilds: number | null

approxUserAuthorizations: number | null

approxUserInstalls: number | null

eventWebhooksStatus: number | null

Discord’s webhook events status: 1 disabled, 2 enabled, 3 disabled by Discord.

libVersion: string | null

name: string

nodeVersion: string | null

release: string | null

sdkVersion: string | null

sessionStartRemaining: number | null

sessionStartTotal: number | null

ts: string


null


checklist: object

Defined in: packages/client/src/results.ts:328

appInfoReceived: boolean

receivingEvents: boolean

requiredPermissionsSet: boolean

webhookEventsEnabled: boolean


lastEventAt: string | null

Defined in: packages/client/src/results.ts:327

Start of the last minute an event arrived in, within the last 14 days.


periodStart: string

Defined in: packages/client/src/results.ts:325

First day of the current salt period.


runs30d: object[]

Defined in: packages/client/src/results.ts:320

UTC days with runs in the last 30.

day: string

failures: number | null

runs: number


sdkInstances: SdkInstance[]

Defined in: packages/client/src/results.ts:318


servers: number

Defined in: packages/client/src/results.ts:322

Servers the bot is in now.


uniqueUsersThisPeriod: number | null

Defined in: packages/client/src/results.ts:323