Skip to content

Create a scheduled report

POST
/v1/reports
curl --request POST \
--url https://stats.example.com/v1/reports \
--header 'Content-Type: application/json' \
--cookie shardlens_session=<shardlens_session> \
--data '{ "name": "example", "schedule": "daily", "hour": 1, "weekday": 1, "webhookUrl": "example" }'

A daily or weekly summary posted to a Discord channel. The webhook must be a Discord webhook URL; it is stored encrypted. Reports contain counts only.

Media typeapplication/json
object
name
required
string
>= 1 characters <= 64 characters
schedule
required
string
Allowed values: daily weekly
hour
required
integer
<= 23
weekday
integer
default: 1 >= 1 <= 7
webhookUrl
required
string
<= 300 characters

Created

Invalid report or webhook URL

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"
}
]
}