GET
/
guilds
/
{id}
/
analytics
Error
A valid request URL is required to generate request examples
{}

Authorizations

​
x-api-secret
string
header
required

Shared API secret configured via BOT_API_SECRET environment variable.

Path Parameters

​
id
string
required

Query Parameters

​
range
enum<string>
default:week

Preset time range. Use 'custom' with from/to for a specific window.

Available options:
today,
week,
month,
custom
​
from
string<date-time>

Start of custom date range (ISO 8601). Required when range=custom.

​
to
string<date-time>

End of custom date range (ISO 8601). Required when range=custom.

​
interval
enum<string>

Bucket size for time-series data. Auto-selected if omitted.

Available options:
hour,
day
​
compare
enum<string>

When set, includes comparison data for the previous equivalent period.

Available options:
1,
true,
yes,
on
​
channelId
string

Optional filter by channel ID

Response

Analytics dataset

The response is of type object.