Staff
Retrieve Staff Dashboard
API Documentation
Activity
- In-Game Tracking
- Users
- Sessions
- GETRetrieve Leaderboard
Order Logging
Staff
Workspace
- GETRetrieve a Workspace
- POSTUpdate a Workspace
- GETList Games
- POSTCreate Game
- DELDelete a Game
- GETList Roles
- POSTCreate a Role
- PUTUpdate Role
- DELDelete a Role
- GETList logbook templates
- GETRetrieve Logbook Template
- POSTCreate a Logbook Template
- PATCHUpdate a Logbook Template
- DELDelete a Logbook Template
- GETRetrieve GApps Config
- POSTSet GApps Service Account
- PATCHUpdate GApps Config
- DELDelete GApps Config
- GETGet Trello Config
- GETGet Trello boards
- POSTSet Trello board
- POSTSet Trello format
- DELDisconnect Trello board
- DELDelete Trello Config
- GETRetrieve Schedules
- POSTCreate a Schedule
- POSTUpdate a Schedule
Trello Integration
Bans (Invite Only)
Connections
Staff
Retrieve Staff Dashboard
Retrieve workspace staff dashboard.
GET
/
staff
/
dashboard
/
{workspaceId}
curl --request GET \
--url https://api.hyra.io/staff/dashboard/{workspaceId} \
--header 'Authorization: Bearer <token>'
{
"total_staff": 123,
"average_minutes": 123,
"top_six": [
{
"_id": "<string>",
"position": 123,
"username": "<string>",
"total": 123
}
],
"currently_playing": [
{
"_id": "<string>",
"username": "<string>"
}
],
"assignment_progress": {
"total_with_assignments": 123,
"total_with_all_assignments_completed": 123
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Response
200 - application/json
Default Response
The response is of type object
.
curl --request GET \
--url https://api.hyra.io/staff/dashboard/{workspaceId} \
--header 'Authorization: Bearer <token>'
{
"total_staff": 123,
"average_minutes": 123,
"top_six": [
{
"_id": "<string>",
"position": 123,
"username": "<string>",
"total": 123
}
],
"currently_playing": [
{
"_id": "<string>",
"username": "<string>"
}
],
"assignment_progress": {
"total_with_assignments": 123,
"total_with_all_assignments_completed": 123
}
}