ShardlensClient
Defined in: packages/client/src/client.ts:63
Reads one collector. Every method rejects with a ShardlensClientError when it can’t get an answer.
Properties
Section titled “Properties”activity
Section titled “activity”
readonlyactivity:ShardlensActivity
Defined in: packages/client/src/client.ts:121
Who ran what: the activity log of a collector in audit mode.
Methods
Section titled “Methods”audience()
Section titled “audience()”audience(
spec,options?):Promise<AudienceResult>
Defined in: packages/client/src/client.ts:85
Unique users per day, week and salt period, and how runs split by locale, install, context and member tier.
Parameters
Section titled “Parameters”Omit<AudienceQuery, "kind">
options?
Section titled “options?”Returns
Section titled “Returns”Promise<AudienceResult>
bursts()
Section titled “bursts()”bursts(
spec,options?):Promise<BurstsResult>
Defined in: packages/client/src/client.ts:91
Minutes with far more runs than the median minute.
Parameters
Section titled “Parameters”Omit<BurstsQuery, "kind">
options?
Section titled “options?”Returns
Section titled “Returns”Promise<BurstsResult>
command()
Section titled “command()”command(
name,spec,options?):Promise<CommandResult>
Defined in: packages/client/src/client.ts:71
One command in depth: outcomes, subcommands, options, where and by whom it runs.
Parameters
Section titled “Parameters”string
Omit<CommandQuery, "kind" | "name">
options?
Section titled “options?”Returns
Section titled “Returns”Promise<CommandResult>
commands()
Section titled “commands()”commands(
spec,options?):Promise<CommandsResult>
Defined in: packages/client/src/client.ts:69
Every command that ran or is registered, compared with the period before.
Parameters
Section titled “Parameters”Omit<CommandsQuery, "kind">
options?
Section titled “options?”Returns
Section titled “Returns”Promise<CommandsResult>
eventProps()
Section titled “eventProps()”Call Signature
Section titled “Call Signature”eventProps(
spec,options?):Promise<EventPropValues>
Defined in: packages/client/src/client.ts:99
One custom event’s property names or, with prop, the most common values of that property.
Parameters
Section titled “Parameters”Omit<EventPropsQuery, "kind" | "prop"> & object
options?
Section titled “options?”Returns
Section titled “Returns”Promise<EventPropValues>
Call Signature
Section titled “Call Signature”eventProps(
spec,options?):Promise<EventPropKeys>
Defined in: packages/client/src/client.ts:103
Parameters
Section titled “Parameters”Omit<EventPropsQuery, "kind" | "prop"> & object
options?
Section titled “options?”Returns
Section titled “Returns”Promise<EventPropKeys>
Call Signature
Section titled “Call Signature”eventProps(
spec,options?):Promise<EventPropsResult>
Defined in: packages/client/src/client.ts:107
Parameters
Section titled “Parameters”Omit<EventPropsQuery, "kind">
options?
Section titled “options?”Returns
Section titled “Returns”Promise<EventPropsResult>
events()
Section titled “events()”events(
spec,options?):Promise<EventsResult>
Defined in: packages/client/src/client.ts:97
The custom events sent with track().
Parameters
Section titled “Parameters”Omit<EventsQuery, "kind">
options?
Section titled “options?”Returns
Section titled “Returns”Promise<EventsResult>
funnel()
Section titled “funnel()”funnel(
spec,options?):Promise<FunnelResult>
Defined in: packages/client/src/client.ts:109
How many people got through 2 to 5 steps (custom events or commands), in order.
Parameters
Section titled “Parameters”Omit<FunnelQuery, "kind">
options?
Section titled “options?”Returns
Section titled “Returns”Promise<FunnelResult>
gauge()
Section titled “gauge()”gauge(
spec,options?):Promise<GaugeResult>
Defined in: packages/client/src/client.ts:89
A gauge over time, such as shard.ping_ms or memory.rss_bytes.
Parameters
Section titled “Parameters”Omit<GaugeQuery, "kind">
options?
Section titled “options?”Returns
Section titled “Returns”Promise<GaugeResult>
growth()
Section titled “growth()”growth(
spec,options?):Promise<GrowthResult>
Defined in: packages/client/src/client.ts:83
Servers joined and left, activation, cohorts and how long servers stay.
Parameters
Section titled “Parameters”Omit<GrowthQuery, "kind">
options?
Section titled “options?”Returns
Section titled “Returns”Promise<GrowthResult>
heatmap()
Section titled “heatmap()”heatmap(
spec,options?):Promise<HeatmapResult>
Defined in: packages/client/src/client.ts:77
Counts by weekday and hour of the day.
Parameters
Section titled “Parameters”Omit<HeatmapQuery, "kind">
options?
Section titled “options?”Returns
Section titled “Returns”Promise<HeatmapResult>
installs()
Section titled “installs()”installs(
spec,options?):Promise<InstallsResult>
Defined in: packages/client/src/client.ts:95
User installs and removals, from Discord’s webhook events.
Parameters
Section titled “Parameters”Omit<InstallsQuery, "kind">
options?
Section titled “options?”Returns
Section titled “Returns”Promise<InstallsResult>
live()
Section titled “live()”live(
options?):AsyncIterable<LiveUpdate>
Defined in: packages/client/src/client.ts:119
What the bot is doing right now, about once a second, over Server-Sent Events. The connection opens when
iteration starts and is closed when it ends: on the signal, on leaving the loop, or when the collector closes the
stream (a restart, a proxy’s time limit). Call live() again to reconnect.
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”AsyncIterable<LiveUpdate>
meta()
Section titled “meta()”meta(
options?):Promise<Meta>
Defined in: packages/client/src/client.ts:113
The app and how its collector is set up: mode, salt period, time zone, retention.
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<Meta>
overview()
Section titled “overview()”overview(
options?):Promise<OverviewResult>
Defined in: packages/client/src/client.ts:67
The bot at a glance: the last 30 days of runs, servers, users, and whether events are arriving.
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<OverviewResult>
premium()
Section titled “premium()”premium(
spec,options?):Promise<PremiumResult>
Defined in: packages/client/src/client.ts:93
Entitlements and subscriptions by SKU, and the premium share of runs.
Parameters
Section titled “Parameters”Omit<PremiumQuery, "kind">
options?
Section titled “options?”Returns
Section titled “Returns”Promise<PremiumResult>
query()
Section titled “query()”query<
S>(spec,options?):Promise<QueryResults[S["kind"]]>
Defined in: packages/client/src/client.ts:65
Runs any query. The answer’s type follows the spec’s kind.
Type Parameters
Section titled “Type Parameters”S extends QuerySpec
Parameters
Section titled “Parameters”S
options?
Section titled “options?”Returns
Section titled “Returns”Promise<QueryResults[S["kind"]]>
reliability()
Section titled “reliability()”reliability(
spec,options?):Promise<ReliabilityResult>
Defined in: packages/client/src/client.ts:87
Missed deadlines, errors, REST calls, rate limits, shards and the SDK’s own health.
Parameters
Section titled “Parameters”Omit<ReliabilityQuery, "kind">
options?
Section titled “options?”Returns
Section titled “Returns”Promise<ReliabilityResult>
retention()
Section titled “retention()”retention(
spec,options?):Promise<RetentionResult>
Defined in: packages/client/src/client.ts:111
People who did one thing, by when they first did, and how many came back in each later period.
Parameters
Section titled “Parameters”Omit<RetentionQuery, "kind">
options?
Section titled “options?”Returns
Section titled “Returns”Promise<RetentionResult>
series()
Section titled “series()”series(
spec,options?):Promise<SeriesResult>
Defined in: packages/client/src/client.ts:73
A metric over time, optionally split by one dimension.
Parameters
Section titled “Parameters”Omit<SeriesQuery, "kind">
options?
Section titled “options?”Returns
Section titled “Returns”Promise<SeriesResult>
server()
Section titled “server()”server(
guild,options?):Promise<ServerResult>
Defined in: packages/client/src/client.ts:81
One server’s profile and history. found is false for a server the collector has never seen.
Parameters
Section titled “Parameters”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<ServerResult>
servers()
Section titled “servers()”servers(
spec?,options?):Promise<ServersResult>
Defined in: packages/client/src/client.ts:79
The servers the bot is or was in, filtered and sorted, one page at a time.
Parameters
Section titled “Parameters”Omit<ServersQuery, "kind">
options?
Section titled “options?”Returns
Section titled “Returns”Promise<ServersResult>
top(
spec,options?):Promise<TopResult>
Defined in: packages/client/src/client.ts:75
The busiest values of one dimension: top commands, top servers, top routes.
Parameters
Section titled “Parameters”Omit<TopQuery, "kind">
options?
Section titled “options?”Returns
Section titled “Returns”Promise<TopResult>