Modbot Docs
APIAPI referenceAnalytics

Get instance activity

GET/api/analytics/instances/activity

How many people were in the group's instances, moment by moment, over the last day, week (the default), month or all recorded time. Built from VRChat's own head counts -- userCount from each open group instance's page, read about every thirty seconds -- so it covers instances no moderator's companion was in. A count is kept only when it changes, so the series is a staircase and each point holds until the next. Long ranges are thinned to at most about 500 points: the window is cut into equal steps and the last reading in each is kept. instances is how many instances had a count at that moment.

Needs the ViewAnalytics permission.

AuthorizationBearer <token>

An API key, made on Settings, API keys. Every key starts with mbk_.

In: header

Query Parameters

range?string

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/api/analytics/instances/activity"
{  "range": "string",  "from": "2019-08-24T14:15:22Z",  "to": "2019-08-24T14:15:22Z",  "stepSeconds": 0,  "points": [    {      "at": "2019-08-24T14:15:22Z",      "people": 0,      "instances": 0    }  ],  "generatedAt": "2019-08-24T14:15:22Z",  "daysWithoutHeadCounts": [    "2019-08-24"  ]}

Modbot is not endorsed by or affiliated with VRChat Inc. or Discord Inc. VRChat is a trademark of VRChat Inc. Discord is a trademark of Discord Inc. SteamVR is a trademark of Valve Corporation. Windows is a trademark of Microsoft Corporation. Docker is a trademark of Docker, Inc. PostgreSQL is a trademark of the PostgreSQL Community Association of Canada. Railway is a trademark of Railway Corp. Other names are trademarks of their respective owners; see Legal. Modbot and its logo are trademarks of the Modbot project. Open source under AGPL-3.0.