Skip to content

Change settings

PUT
/v1/settings
curl --request PUT \
--url https://stats.example.com/v1/settings \
--header 'Content-Type: application/json' \
--cookie shardlens_session=<shardlens_session> \
--data '{ "timezone": "example", "rawRetentionDays": 1, "auditRetentionDays": 1, "mode": "privacy", "saltPeriod": "day", "requiredPermissions": "example", "skuPrices": { "additionalProperty": { "amount": 1, "currency": "example" } }, "sampling": { "additionalProperty": 1 }, "badges": [ "servers" ] }'

Audit retention above 90 days is rejected. Audit mode needs SHARDLENS_AUDIT_KEY on the collector.

Media typeapplication/json
object
timezone
string
<= 64 characters
rawRetentionDays
integer
>= 7 <= 90
auditRetentionDays
integer
>= 1 <= 90
mode
string
Allowed values: privacy audit
saltPeriod
string
Allowed values: day week month
requiredPermissions
string
nullable /^\d{1,19}$/
skuPrices
object
key
additional properties
object
amount
required
number
<= 1000000
currency
required
string
/^[A-Z]{3}$/
sampling
object
key
additional properties
number
>= 0.0001 <= 1
badges
Array<string>
<= 3 items
Allowed values: servers users-monthly commands-daily

Updated settings

Invalid settings

Media typeapplication/json
object
error
required
string
<= 64 characters
message
string
<= 500 characters
rejected
Array<object>
object
index
required
integer
<= 9007199254740991
reason
required
string
<= 64 characters

Example generated

{
"error": "example",
"message": "example",
"rejected": [
{
"index": 1,
"reason": "example"
}
]
}

Not signed in

Media typeapplication/json
object
error
required
string
<= 64 characters
message
string
<= 500 characters
rejected
Array<object>
object
index
required
integer
<= 9007199254740991
reason
required
string
<= 64 characters

Example generated

{
"error": "example",
"message": "example",
"rejected": [
{
"index": 1,
"reason": "example"
}
]
}

Needs a Discord sign-in (owner or team) and, for changes, the CSRF header

Media typeapplication/json
object
error
required
string
<= 64 characters
message
string
<= 500 characters
rejected
Array<object>
object
index
required
integer
<= 9007199254740991
reason
required
string
<= 64 characters

Example generated

{
"error": "example",
"message": "example",
"rejected": [
{
"index": 1,
"reason": "example"
}
]
}