Activity
Retrieve Leaderboard
- Changelog
- Community
- Introduction
Lua Module
- GETRetrieve Orders
- GETSearch Orders
- GETRetrieve Order Timeline
- POSTCreate Order
- PATCHUpdate Order
- 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
API Documentation
Order Logging
Workspace
Activity
Retrieve Leaderboard
Get a workspace’s leaderboard
GET
/
activity
/
{workspaceId}
/
leaderboard
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
workspaceId
string
*
workspaceId
Required
string
curl --request GET \
--url https://api.hyra.io/activity/{workspaceId}/leaderboard \
--header 'Authorization: Bearer <token>'{
"playtime": {
"top_three": [
{
"_id": "<string>",
"position": 123,
"total": 123,
"in_game": true
}
],
"you": {
"_id": "<string>",
"position": 123,
"total": 123,
"in_game": true
}
},
"sessions": {
"top_three": [
{
"_id": "<string>",
"position": 123,
"total": 123
}
],
"you": {
"_id": "<string>",
"position": 123,
"total": 123
}
}
}Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
workspaceId
string
requiredResponse
200 - application/json
playtime
object
requiredplaytime.top_three
object[]
requiredplaytime.top_three._id
string
requiredplaytime.top_three.position
number
requiredplaytime.top_three.total
number
requiredplaytime.top_three.in_game
boolean
requiredplaytime.you
object
requiredplaytime.you._id
string
requiredplaytime.you.position
number
requiredplaytime.you.total
number
requiredplaytime.you.in_game
boolean
requiredsessions
object
requiredsessions.top_three
object[]
requiredsessions.top_three._id
string
requiredsessions.top_three.position
number
requiredsessions.top_three.total
number
requiredsessions.you
object
requiredsessions.you._id
string
requiredsessions.you.position
number
requiredsessions.you.total
number
requiredcurl --request GET \
--url https://api.hyra.io/activity/{workspaceId}/leaderboard \
--header 'Authorization: Bearer <token>'{
"playtime": {
"top_three": [
{
"_id": "<string>",
"position": 123,
"total": 123,
"in_game": true
}
],
"you": {
"_id": "<string>",
"position": 123,
"total": 123,
"in_game": true
}
},
"sessions": {
"top_three": [
{
"_id": "<string>",
"position": 123,
"total": 123
}
],
"you": {
"_id": "<string>",
"position": 123,
"total": 123
}
}
}