Get instance
/api/instances/{id}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.
An API key, made on Settings, API keys. Every key starts with mbk_.
In: header
Path Parameters
uuidResponse 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"{ "instance": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "location": "string", "worldId": "string", "worldName": null, "worldThumbnailImageUrl": null, "vrChatInstanceId": null, "instanceName": null, "groupAccessType": null, "region": null, "openedAt": "2019-08-24T14:15:22Z", "closedAt": null, "closedBy": null, "peopleNow": null, "peakPeople": null, "minutesOpen": 0.1, "worldCapacity": null, "worldPlatforms": null, "closedByModerator": false, "peopleNowUnsure": false, "peakPeopleUnsure": false }, "known": true, "worldAuthorName": null, "worldImageUrl": null, "worldCapacity": null, "type": null, "groupId": null, "lastSeenAt": "2019-08-24T14:15:22Z", "seenInGroupList": true, "counts": { "minutesSeen": 0.1, "visitors": 0, "arrivals": 0, "lastSeenAt": null }, "returningMembers": 0, "canSeeWhoWasThere": true, "people": [ { "userId": "string", "displayName": null, "minutesSeen": 0.1, "arrivals": 0, "firstSeenAt": "2019-08-24T14:15:22Z", "lastSeenAt": "2019-08-24T14:15:22Z" } ], "now": "2019-08-24T14:15:22Z", "headCounts": [ { "at": "2019-08-24T14:15:22Z", "people": 0, "userCount": null, "memberCount": null, "source": "string", "nUsers": null, "unsure": false, "change": null } ], "peoplePresent": [ { "at": "2019-08-24T14:15:22Z", "members": 0, "visitor": 0, "newUser": 0, "user": 0, "knownUser": 0, "trustedUser": 0, "legend": 0, "nuisance": 0, "vrChatTeam": 0, "rankUnknown": 0 } ]}Get world GET
One world: what its page said, the instances that have run in it, and how busy it was. Read from Modbot's own tables; nothing here calls VRChat. `known` is false when Modbot has only ever seen the id. `name` is null when the world page has not been read yet — ordinary for a few minutes after a new world turns up, and permanent for a private or deleted one. Time and visitors come from the desktop client's presence reports and exist only while a moderator's client was in the instance; instances opened come from the group's own instance list and are complete. Needs the `ViewAnalytics` permission.
Get how an instance compared with its world GET
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.