Get instance analytics
/api/analytics/instancesInstances: when is the community actually active? Instances opened and closed per day (daily totals), most open at once and the most people seen in one instance per day, how long instances typically stay open and how that moves day by day, and an hour-of-week heatmap of arrivals and openings. Hours are UTC; the page shifts them to the viewer's time zone. peaks carries the most people in the group's instances at one moment, the most instances counted at once, the busiest day and the busiest clock hour, and the fullest single instance -- each with when it happened -- from VRChat's own head counts, which need no moderator's companion. peaks.coverage says how much of the time instances were open Modbot actually had a count for, and marks the figures thin below half of it. presenceReports does the same for the heatmap and the per-instance population, which do come from the companion.
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/instances"{ "from": "2019-08-24", "to": "2019-08-24", "today": null, "opened": [ { "day": "2019-08-24", "value": 0.1 } ], "closedByHand": [ { "day": "2019-08-24", "value": 0.1 } ], "endedOnTheirOwn": [ { "day": "2019-08-24", "value": 0.1 } ], "mostOpenAtOnce": [ { "day": "2019-08-24", "value": 0.1 } ], "mostPeopleInOne": [ { "day": "2019-08-24", "value": 0.1 } ], "typicalMinutesOpen": null, "typicalMinutesOpenPerDay": [ { "day": "2019-08-24", "value": 0.1 } ], "instancesWithBothEnds": 0, "instancesOpened": 0, "openNow": [ { "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 } ], "recent": [ { "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 } ], "hourOfWeek": { "arrivals": [ 0.1 ], "opened": [ 0.1 ] }, "peaks": { "mostPeopleAtOnce": null, "mostInstancesAtOnce": null, "busiestDay": null, "busiestHour": null, "busiestInstance": null, "mostPeopleAtOncePerDay": [ { "day": "2019-08-24", "value": 0.1 } ], "peopleMinutesPerDay": [ { "day": "2019-08-24", "value": 0.1 } ], "coverage": { "windowDays": 0, "daysCounted": 0, "instancesOpen": 0, "instancesCounted": 0, "minutesInstancesWereOpen": 0.1, "minutesCounted": 0.1, "thin": true } }, "presenceReports": 0, "daysWithoutAuditLog": [ "2019-08-24" ], "daysWithoutHeadCounts": [ "2019-08-24" ], "daysWithoutPresenceReports": [ "2019-08-24" ], "daysBeforeModbot": [ "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"}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.
Get instance activity GET
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.