Skip to main content
GET
/
roll-events
/
stats
Get Aggregated Roll Statistics
curl --request GET \
  --url https://forgegames.org/api/roll-events/stats \
  --header 'Authorization: Basic <encoded-value>'
{
  "totalRolls": 123,
  "uniqueItems": 123,
  "rollsByTemplate": {},
  "rollsByDay": [
    {
      "date": "<string>",
      "count": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

​
startDate
string
​
endDate
string
​
templateId
string

Response

Successful response

​
totalRolls
number
required
​
uniqueItems
number
required
​
rollsByTemplate
object
required
​
rollsByDay
object[]
required