Send a batch of events
POST
/v1/ingest
const url = 'https://stats.example.com/v1/ingest';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"v":1,"mode":"privacy","sdk":{"name":"example","version":"example"},"app":{"id":"example","env":"example","release":"example"},"source":{"shards":[1],"cluster":1,"instance":"example"},"sentAt":"2026-04-15T12:00:00Z","events":[{"id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","ts":1,"weight":1,"type":"interaction","kind":"chat_input","command":"example","group":"example","sub":"example","commandId":"example","commandScope":"global","options":[],"optionValues":{"additionalProperty":"example"},"customId":"example","componentType":1,"sourceCommand":"example","context":0,"install":"guild","guild":"example","channelType":1,"locale":"example","guildLocale":"example","memberTier":"admin","user":"example","actor":{"userId":"example","username":"example","avatar":"example"},"premium":true,"outcome":"ok","errorCode":1,"errorClass":"example","ackMs":1,"responseType":1,"deferred":true,"ephemeral":true,"handlerMs":1,"shard":1}]}'};
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/ingest \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "v": 1, "mode": "privacy", "sdk": { "name": "example", "version": "example" }, "app": { "id": "example", "env": "example", "release": "example" }, "source": { "shards": [ 1 ], "cluster": 1, "instance": "example" }, "sentAt": "2026-04-15T12:00:00Z", "events": [ { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "ts": 1, "weight": 1, "type": "interaction", "kind": "chat_input", "command": "example", "group": "example", "sub": "example", "commandId": "example", "commandScope": "global", "options": [], "optionValues": { "additionalProperty": "example" }, "customId": "example", "componentType": 1, "sourceCommand": "example", "context": 0, "install": "guild", "guild": "example", "channelType": 1, "locale": "example", "guildLocale": "example", "memberTier": "admin", "user": "example", "actor": { "userId": "example", "username": "example", "avatar": "example" }, "premium": true, "outcome": "ok", "errorCode": 1, "errorClass": "example", "ackMs": 1, "responseType": 1, "deferred": true, "ephemeral": true, "handlerMs": 1, "shard": 1 } ] }'Gzipped JSON (Content-Encoding: gzip), at most 500 events, 1 MB compressed and 5 MB decompressed. Invalid events are rejected one by one; duplicates (retries) are counted, not stored twice.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
Shardlens batch (wire format v1)
object
v
required
number
mode
required
string
sdk
required
object
name
required
string
version
required
string
app
required
object
id
required
string
env
required
string
release
string
source
required
object
shards
required
Array<integer>
cluster
integer
instance
required
string
sentAt
required
string format: date-time
events
required
Array
One of:
object
id
required
string format: uuid
ts
required
integer
weight
number
type
required
string
kind
required
string
command
string
group
string
sub
string
commandId
string
commandScope
string
options
Array<string>
customId
string
componentType
integer
sourceCommand
string
install
string
guild
string
channelType
integer
locale
required
string
guildLocale
string
memberTier
string
user
required
string
actor
object
userId
required
string
username
string
avatar
string
premium
required
boolean
outcome
required
string
errorCode
integer
errorClass
string
ackMs
integer
responseType
integer
deferred
boolean
ephemeral
boolean
handlerMs
integer
shard
integer
object
id
required
string format: uuid
ts
required
integer
weight
number
type
required
string
interaction
required
string format: uuid
command
string
errorClass
required
string
errorCode
integer
handlerMs
integer
object
id
required
string format: uuid
ts
required
integer
weight
number
type
required
string
command
required
string
group
string
sub
string
options
Array<string>
guild
string
channelType
integer
guildLocale
string
memberTier
string
user
required
string
actor
object
userId
required
string
username
string
avatar
string
outcome
required
string
errorClass
string
errorCode
integer
handlerMs
integer
shard
integer
object
id
required
string format: uuid
ts
required
integer
weight
number
type
required
string
guild
required
string
command
required
string
overwrites
required
integer
object
id
required
string format: uuid
ts
required
integer
weight
number
type
required
string
info
required
object
guild
required
string
name
required
string
memberCount
required
integer
large
required
boolean
preferredLocale
required
string
features
required
Array<string>
premiumTier
required
integer
verificationLevel
required
integer
nsfwLevel
required
integer
mfaLevel
required
integer
createdAt
required
integer
joinedAt
required
integer
shard
required
integer
channelCounts
required
object
key
additional properties
integer
roleCount
required
integer
emojiCount
required
integer
stickerCount
required
integer
botPermissions
required
string
detectedAtStartup
required
boolean
object
id
required
string format: uuid
ts
required
integer
weight
number
type
required
string
info
required
object
guild
required
string
name
required
string
memberCount
required
integer
large
required
boolean
preferredLocale
required
string
features
required
Array<string>
premiumTier
required
integer
verificationLevel
required
integer
nsfwLevel
required
integer
mfaLevel
required
integer
createdAt
required
integer
joinedAt
required
integer
shard
required
integer
channelCounts
required
object
key
additional properties
integer
roleCount
required
integer
emojiCount
required
integer
stickerCount
required
integer
botPermissions
required
string
object
id
required
string format: uuid
ts
required
integer
weight
number
type
required
string
guild
required
string
detectedAtStartup
required
boolean
object
id
required
string format: uuid
ts
required
integer
weight
number
type
required
string
guild
required
string
available
required
boolean
shard
required
integer
object
id
required
string format: uuid
ts
required
integer
weight
number
type
required
string
shards
required
Array<integer>
shardCount
required
integer
guilds
required
Array<string>
object
id
required
string format: uuid
ts
required
integer
weight
number
type
required
string
commands
required
Array<object>
object
id
required
string
name
required
string
type
required
integer
guild
string
subcommands
Array<string>
object
id
required
string format: uuid
ts
required
integer
weight
number
type
required
string
shard
required
integer
state
required
string
closeCode
integer
replayed
integer
unavailableGuilds
integer
object
id
required
string format: uuid
ts
required
integer
weight
number
type
required
string
windowMs
required
integer
rows
required
Array<object>
object
method
required
string
route
required
string
status
required
integer
count
required
integer
retries
required
integer
latency
required
Array<integer>
invalid
required
object
count401
required
integer
count403
required
integer
count429
required
integer
shared429
required
integer
object
id
required
string format: uuid
ts
required
integer
weight
number
type
required
string
scope
required
string
global
required
boolean
route
required
string
method
required
string
limit
required
integer
retryAfter
required
number
sublimitTimeout
required
number
object
id
required
string format: uuid
ts
required
integer
weight
number
type
required
string
count
required
integer
remainingTime
required
number
object
id
required
string format: uuid
ts
required
integer
weight
number
type
required
string
gauges
required
Array<object>
object
name
required
string
shard
integer
value
required
number
object
id
required
string format: uuid
ts
required
integer
weight
number
type
required
string
action
required
string
status
required
integer
skus
required
Array<string>
user
required
string
periodStart
required
integer
periodEnd
required
integer
object
id
required
string format: uuid
ts
required
integer
weight
number
type
required
string
name
required
string
dashboardUserIds
required
Array<string>
skus
required
Array<object>
object
id
required
string
name
required
string
type
required
integer
sessionStartRemaining
integer
sessionStartTotal
integer
nodeVersion
required
string
libVersion
required
string
object
id
required
string format: uuid
ts
required
integer
weight
number
type
required
string
queueDepth
required
integer
dropped
required
object
key
additional properties
integer
failedFlushes
required
integer
internalErrors
required
object
key
additional properties
integer
Responses
Section titled “Responses”Accepted
Media typeapplication/json
object
accepted
required
integer
duplicates
required
integer
rejected
Array<object>
object
index
required
integer
reason
required
string
Example
{ "rejected": []}Invalid batch envelope, or audit data sent to a privacy-mode app
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" } ]}The batch is for another application
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" } ]}Body too large
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" } ]}Rate limited; retry after the Retry-After header
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" } ]}Busy; retry after the Retry-After header
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" } ]}