Users
Get User Activity
- 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
Users
Get User Activity
Get a user’s activity for this week, and the last 25 activities
GET
/
activity
/
{workspaceId}
/
user
/
{userId}
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
userId
string
*
userId
Required
string
The user's ID/@me
workspaceId
string
*
workspaceId
Required
string
withGame
boolean
withGame
boolean
Include the game in the response
curl --request GET \
--url https://api.hyra.io/activity/{workspaceId}/user/{userId} \
--header 'Authorization: Bearer <token>'
{
"totals": {
"minutes": 123,
"messages": 123,
"period": "<string>"
},
"last_25": [
{
"_id": "<string>",
"start": "<string>",
"end": "<string>",
"ended": true,
"game": "<string>",
"friends": [
"<string>"
],
"consolidation_state": "<string>",
"error": "<string>",
"idle_time": 123,
"tracked_idle": 123,
"duration": 123,
"gifted_by": "<string>",
"messages_sent": 123,
"game_details": {
"id": "<string>",
"name": "<string>",
"thumbnail": "<string>",
"url": "<string>",
"dominant": "<string>",
"brightness": 123
}
}
],
"week_starts_on": "<string>"
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
userId
string
requiredThe user's ID/@me
workspaceId
string
requiredQuery Parameters
withGame
boolean
Include the game in the response
Response
200 - application/json
totals
object
requiredtotals.minutes
number
requiredtotals.messages
number
requiredtotals.period
string
requiredlast_25
object[]
requiredlast_25._id
string
requiredlast_25.start
string
requiredlast_25.end
string
last_25.ended
boolean
requiredlast_25.game
string
requiredlast_25.friends
string[]
last_25.consolidation_state
string
last_25.error
string
last_25.idle_time
number
last_25.tracked_idle
number
requiredlast_25.duration
number
last_25.gifted_by
string
last_25.messages_sent
number
last_25.game_details
object
Only returned if ?withGame=true
last_25.game_details.id
string
last_25.game_details.name
string
last_25.game_details.thumbnail
string
last_25.game_details.url
string
last_25.game_details.dominant
string
last_25.game_details.brightness
number
week_starts_on
string
requiredcurl --request GET \
--url https://api.hyra.io/activity/{workspaceId}/user/{userId} \
--header 'Authorization: Bearer <token>'
{
"totals": {
"minutes": 123,
"messages": 123,
"period": "<string>"
},
"last_25": [
{
"_id": "<string>",
"start": "<string>",
"end": "<string>",
"ended": true,
"game": "<string>",
"friends": [
"<string>"
],
"consolidation_state": "<string>",
"error": "<string>",
"idle_time": 123,
"tracked_idle": 123,
"duration": 123,
"gifted_by": "<string>",
"messages_sent": 123,
"game_details": {
"id": "<string>",
"name": "<string>",
"thumbnail": "<string>",
"url": "<string>",
"dominant": "<string>",
"brightness": 123
}
}
],
"week_starts_on": "<string>"
}