Get world
/api/worldsOne 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.
An API key, made on Settings, API keys. Every key starts with mbk_.
In: header
Query Parameters
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/api/worlds?id=string"{ "worldId": "string", "known": true, "name": null, "description": null, "authorId": null, "authorName": null, "imageUrl": null, "thumbnailImageUrl": null, "capacity": null, "recommendedCapacity": null, "tags": [ "string" ], "releaseStatus": null, "publishedAt": null, "updatedAt": null, "firstSeenAt": null, "lastSeenAt": null, "lastReadAt": null, "readError": null, "counts": { "minutesSeen": 0.1, "visitors": 0, "arrivals": 0, "lastSeenAt": null }, "instances": [ { "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 } ], "instancesTotal": 0, "instancesOpenNow": 0, "visitorsPerDay": [ { "day": "2019-08-24", "value": 0.1 } ], "instancesPerDay": [ { "day": "2019-08-24", "value": 0.1 } ], "now": "2019-08-24T14:15:22Z"}Pick the spotlight's member POST
Picks the member for a spotlight draft that has none (staff mode) and fills the draft with their card: their name, their avatar and the answers they opened to Members, above any text already there. Only a member who opted in and is still in the server is taken. The note is written and the post sent from Marketing as for any post. Refused (409) once a member is picked, and once the draft has gone out or is being sent. Needs the `ManagePosts` permission.
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.