Get world analytics
/api/analytics/worldsWorlds: which of our worlds actually get used? For each world: the group instances Modbot saw opened, how long at least one was open, and the most people VRChat counted in one, longest time open first. Beside them, time people were seen, distinct visitors and audit-log instance creates, plus visitors per day per world from daily totals. Time seen and visitors come from presence reports, which exist only while a moderator's companion is in the instance.
Needs the ViewAnalytics permission.
An API key, made on Settings, API keys. Every key starts with mbk_.
In: header
Query Parameters
int32datedateResponse Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/api/analytics/worlds"{ "from": "2019-08-24", "to": "2019-08-24", "today": null, "worlds": [ { "worldId": "string", "name": null, "authorName": null, "thumbnailImageUrl": null, "capacity": null, "minutesSeen": 0.1, "visitors": 0, "visits": 0, "lastSeenAt": null, "instances": 0, "minutesOpen": 0.1, "mostAtOnce": null, "mostAtOnceUnsure": true, "lastOpenedAt": null } ], "visitorsPerDay": [ { "worldId": "string", "points": [ { "day": "2019-08-24", "value": 0.1 } ] } ], "presenceReports": 0, "daysWithoutPresenceReports": [ "2019-08-24" ], "coverage": { "dailyTotalsFirstDay": null, "dailyTotalsLastDay": null, "dailyTotalsUpdatedAt": null, "factFirstDay": null, "factLastDay": null, "retentionConfigured": true, "moderationFactRetentionDays": 0, "presenceFactRetentionDays": 0 }, "generatedAt": "2019-08-24T14:15:22Z"}Set when an instance wants a moderator PUT
How many people in one group instance mean it wants a moderator in it: the head count that makes an hour busy in the Moderation tab's `cover`, and the bar its list of gaps starts at. From 1 to 100; 3 until it is changed. Needs the `ManageSettings` permission.
Get regulars and return rate GET
Regulars: do people come back? A visitor in a week is anybody who joined any of the group's instances that week (weeks run Monday to Sunday, UTC). They came back if they joined a group instance again in any of the next four weeks; the week's rate is the ones who came back over the visitors, and `cameBack` is null until those four weeks are over. A regular joined in at least three of the latest four whole weeks; the list is the first 200, most days first, and `regularsTotal` counts them all. Joins come from presence reports, which exist only while a moderator's companion is in the instance, so a person who came back to an instance nobody from the team attended is not counted as coming back. Needs the `ViewAnalytics` permission.