Run a typed query
POST
/v1/query
const url = 'https://stats.example.com/v1/query';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"kind":"series","metric":"interactions","name":"example","range":{"from":"2026-04-15T12:00:00Z","to":"2026-04-15T12:00:00Z"},"interval":"minute","groupBy":"command","stat":"count","filters":[],"timezone":"UTC","limit":10}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://stats.example.com/v1/query \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "kind": "series", "metric": "interactions", "name": "example", "range": { "from": "2026-04-15T12:00:00Z", "to": "2026-04-15T12:00:00Z" }, "interval": "minute", "groupBy": "command", "stat": "count", "filters": [], "timezone": "UTC", "limit": 10 }'Every query kind maps to a fixed SQL template with bound parameters. There is no per-user grouping.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
One of:
object
kind
required
string
metric
required
string
name
string
range
required
object
from
required
string format: date-time
to
required
string format: date-time
interval
required
string
groupBy
string
stat
string
filters
Array<object>
object
timezone
string
limit
integer
object
kind
required
string
metric
required
string
name
string
range
required
object
from
required
string format: date-time
to
required
string format: date-time
groupBy
required
string
stat
string
filters
Array<object>
object
limit
integer
object
kind
required
string
metric
string
range
required
object
from
required
string format: date-time
to
required
string format: date-time
filters
Array<object>
object
timezone
string
object
kind
required
string
range
required
object
from
required
string format: date-time
to
required
string format: date-time
object
kind
required
string
name
required
string
range
required
object
from
required
string format: date-time
to
required
string format: date-time
object
kind
required
string
search
string
status
string
feature
string
locale
string
size
string
inactive
boolean
missingPermissions
boolean
sort
string
order
string
limit
integer
offset
integer
object
kind
required
string
guild
required
string
object
kind
required
string
range
required
object
from
required
string format: date-time
to
required
string format: date-time
timezone
string
object
kind
required
string
range
required
object
from
required
string format: date-time
to
required
string format: date-time
object
kind
required
string
object
kind
required
string
name
required
string
range
required
object
from
required
string format: date-time
to
required
string format: date-time
interval
required
string
perShard
boolean
timezone
string
object
kind
required
string
range
required
object
from
required
string format: date-time
to
required
string format: date-time
factor
number
object
kind
required
string
range
required
object
from
required
string format: date-time
to
required
string format: date-time
object
kind
required
string
range
required
object
from
required
string format: date-time
to
required
string format: date-time
object
kind
required
string
range
required
object
from
required
string format: date-time
to
required
string format: date-time
timezone
string
object
kind
required
string
range
required
object
from
required
string format: date-time
to
required
string format: date-time
object
kind
required
string
name
required
string
range
required
object
from
required
string format: date-time
to
required
string format: date-time
prop
string
object
kind
required
string
start
required
return
range
required
object
from
required
string format: date-time
to
required
string format: date-time
interval
string
timezone
string
Responses
Section titled “Responses”Query result (shape depends on kind)
Invalid query
Media typeapplication/json
object
error
required
string
message
string
rejected
Array<object>
object
index
required
integer
reason
required
string
Example generated
{ "error": "example", "message": "example", "rejected": [ { "index": 1, "reason": "example" } ]}Missing or wrong credentials
Media typeapplication/json
object
error
required
string
message
string
rejected
Array<object>
object
index
required
integer
reason
required
string
Example generated
{ "error": "example", "message": "example", "rejected": [ { "index": 1, "reason": "example" } ]}