CommandResult
Defined in: packages/client/src/results.ts:115
Answer to a command query. Read from single events, which the collector keeps for 7 to 90 days.
Properties
Section titled “Properties”channelTypes
Section titled “channelTypes”channelTypes:
KeyCount[]
Defined in: packages/client/src/results.ts:158
Discord channel type numbers.
components
Section titled “components”components:
object[]
Defined in: packages/client/src/results.ts:163
Buttons and select menus on the command’s messages, by custom ID.
key:
string|null
kind:
string
value:
number
contexts
Section titled “contexts”contexts:
NullableKeyCount[]
Defined in: packages/client/src/results.ts:156
0 server, 1 bot DM, 2 private channel.
from:
string
Defined in: packages/client/src/results.ts:117
Where counting starts: the range’s from, or later when single events are no longer kept that far back.
installs
Section titled “installs”installs:
NullableKeyCount[]
Defined in: packages/client/src/results.ts:154
guild, user or both.
kinds:
KeyCount[]
Defined in: packages/client/src/results.ts:144
latencyHistogram
Section titled “latencyHistogram”latencyHistogram:
number[] |null
Defined in: packages/client/src/results.ts:143
Time to the first response in 40 buckets on a log scale: bucket i ends at 60000 ** ((i + 1) / 39)
milliseconds. null when no run answered.
locales
Section titled “locales”locales:
KeyCount[]
Defined in: packages/client/src/results.ts:159
memberTiers
Section titled “memberTiers”memberTiers:
NullableKeyCount[]
Defined in: packages/client/src/results.ts:152
admin, manager, member or dm.
modals
Section titled “modals”modals:
object[]
Defined in: packages/client/src/results.ts:165
Modals the command opened, and how many were submitted.
customId
Section titled “customId”customId:
string
shown:
number
submitted
Section titled “submitted”submitted:
number
options
Section titled “options”options:
KeyCount[]
Defined in: packages/client/src/results.ts:148
Option names, by how many runs used them.
optionValues
Section titled “optionValues”optionValues:
object[]
Defined in: packages/client/src/results.ts:150
Values of the options the bot lists in captureOptionValues.
option
Section titled “option”option:
string
runs:
number
value:
string
subcommands
Section titled “subcommands”subcommands:
KeyCount[]
Defined in: packages/client/src/results.ts:146
Subcommands, with their group in front (config set).
topServers
Section titled “topServers”topServers:
object[]
Defined in: packages/client/src/results.ts:161
The 10 servers that ran it most. key is the server’s ID.
icon:
string|null
key:
string
name:
string|null
value:
number
totals
Section titled “totals”totals:
object
Defined in: packages/client/src/results.ts:119
Every figure is null when the command did not run in the range.
deferRate
Section titled “deferRate”deferRate:
number|null
Share of runs answered with a deferral, 0 to 1. Prefix commands, which have no response, don’t count.
ephemeralRate
Section titled “ephemeralRate”ephemeralRate:
number|null
Share of runs answered ephemerally, 0 to 1.
error:
number|null
firstSeen
Section titled “firstSeen”firstSeen:
string|null
handlerP95Ms
Section titled “handlerP95Ms”handlerP95Ms:
number|null
95th percentile of the handler’s run time, in milliseconds.
lastSeen
Section titled “lastSeen”lastSeen:
string|null
noResponse
Section titled “noResponse”noResponse:
number|null
ok:
number|null
over3sRate
Section titled “over3sRate”over3sRate:
number|null
Share of answered runs whose first response took more than 3 seconds.
premiumShare
Section titled “premiumShare”premiumShare:
number|null
Share of runs by users with an entitlement, 0 to 1.
runs:
number|null
timeout
Section titled “timeout”timeout:
number|null
Runs whose first response missed Discord’s 3-second deadline.