Modbot Docs
APIAPI referencePlaces

Get how an instance compared with its world

GET/api/instances/{id}/world

How one instance compared with the other instances in its world while it was open: where it ranked by head count at each read of the world's page, the busiest of the others, and how many people were in the world. Read from Modbot's own tables; nothing here waits on VRChat. The world's page is read every two minutes while the group has an instance open in that world, so an instance that closed before those reads began has no readings. The other instances' numbers are the world page's list; this instance's is the list's when the list carries it (listed), and its own head count otherwise.

The first time a shown instance or its group has no name Modbot has asked for, and its location does not say outsiders cannot join (invite, friends, friends+, a group's members or members and their friends), Modbot asks VRChat for it once, in the background, and keeps the answer, a refusal included. namesComing is true while such a read is waiting; asking again a few seconds later shows what it found.

Needs the ViewAnalytics permission.

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/api/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/world"
{  "instanceId": "64d2028c-ae87-4069-a624-66089d957ef9",  "worldId": "string",  "from": "2019-08-24T14:15:22Z",  "to": "2019-08-24T14:15:22Z",  "readings": [    {      "at": "2019-08-24T14:15:22Z",      "occupants": null,      "publicOccupants": null,      "privateOccupants": null,      "people": null,      "unsure": true,      "listed": true,      "rank": null,      "of": 0    }  ],  "others": [    {      "instanceId": "string",      "number": null,      "groupId": null,      "groupAccessType": null,      "region": null,      "ownGroup": true,      "modbotInstanceId": null,      "name": null,      "groupName": null,      "peak": 0,      "firstSeenAt": "2019-08-24T14:15:22Z",      "lastSeenAt": "2019-08-24T14:15:22Z",      "readings": [        {          "at": "2019-08-24T14:15:22Z",          "people": 0        }      ]    }  ],  "othersTotal": 0,  "atPeak": null,  "busiestMinutes": 0.1,  "truncated": true,  "namesComing": false}

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.

Get instance GET

One instance: where it was, when, how busy and who was in it. The id is Modbot's own, not VRChat's number — VRChat hands the same number out again after an instance closes, so two evenings under one number are two instances. What happened there is the audit log, read narrowed to the instance's world and number. Who was in the instance needs ViewAuditLog as well: that is moderation history (spec 5.9.4), while the instance's own shape is not. Without it `canSeeWhoWasThere` is false, `people` is empty, and so is `peoplePresent`: how many members and how many of each trust rank a companion saw, moment by moment, which is drawn as lines a moderator can turn on over the head count. Each head count reading says whether it went `up`, or down at a `kick` recorded about then, or down because somebody `left`. Needs the `ViewAnalytics` permission.

List a person's visits GET

Where one VRChat user has been seen, a visit per row, newest first: the arrival (or "already here" when a moderator's companion arrived after them), the leave when one was seen, `until` (when they left, or the last report from that instance when nobody saw them go), the display name they had, the avatars they were seen changing into, and `seenBy`, the moderators whose companions reported them. Visits are made from the companion's presence reports exactly as the time-in-world figures are, so they only cover time a moderator was in the same instance. Needs ViewAuditLog, the permission that reads the same arrivals and leaves in the audit log. Paged by keyset: send the returned `next` back as beforeStartedAt and beforeId; both are required.