OverviewResult
Defined in: packages/client/src/results.ts:293
Answer to an overview query.
Properties
Section titled “Properties”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
Section titled “appInfo”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.
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ 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
Section titled “approxGuilds”approxGuilds:
number|null
approxUserAuthorizations
Section titled “approxUserAuthorizations”approxUserAuthorizations:
number|null
approxUserInstalls
Section titled “approxUserInstalls”approxUserInstalls:
number|null
eventWebhooksStatus
Section titled “eventWebhooksStatus”eventWebhooksStatus:
number|null
Discord’s webhook events status: 1 disabled, 2 enabled, 3 disabled by Discord.
libVersion
Section titled “libVersion”libVersion:
string|null
name:
string
nodeVersion
Section titled “nodeVersion”nodeVersion:
string|null
release
Section titled “release”release:
string|null
sdkVersion
Section titled “sdkVersion”sdkVersion:
string|null
sessionStartRemaining
Section titled “sessionStartRemaining”sessionStartRemaining:
number|null
sessionStartTotal
Section titled “sessionStartTotal”sessionStartTotal:
number|null
ts:
string
null
checklist
Section titled “checklist”checklist:
object
Defined in: packages/client/src/results.ts:328
appInfoReceived
Section titled “appInfoReceived”appInfoReceived:
boolean
receivingEvents
Section titled “receivingEvents”receivingEvents:
boolean
requiredPermissionsSet
Section titled “requiredPermissionsSet”requiredPermissionsSet:
boolean
webhookEventsEnabled
Section titled “webhookEventsEnabled”webhookEventsEnabled:
boolean
lastEventAt
Section titled “lastEventAt”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
Section titled “periodStart”periodStart:
string
Defined in: packages/client/src/results.ts:325
First day of the current salt period.
runs30d
Section titled “runs30d”runs30d:
object[]
Defined in: packages/client/src/results.ts:320
UTC days with runs in the last 30.
day:
string
failures
Section titled “failures”failures:
number|null
runs:
number
sdkInstances
Section titled “sdkInstances”sdkInstances:
SdkInstance[]
Defined in: packages/client/src/results.ts:318
servers
Section titled “servers”servers:
number
Defined in: packages/client/src/results.ts:322
Servers the bot is in now.
uniqueUsersThisPeriod
Section titled “uniqueUsersThisPeriod”uniqueUsersThisPeriod:
number|null
Defined in: packages/client/src/results.ts:323