Get regulars and return rate
/api/analytics/regularsRegulars: 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.
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/regulars"{ "from": "2019-08-24", "to": "2019-08-24", "weeks": [ { "weekStart": "2019-08-24", "visitors": 0, "cameBack": null } ], "returnWeeks": 0, "regularWeeks": 0, "regularNeeds": 0, "regularsFrom": "2019-08-24", "regularsTo": "2019-08-24", "regularsTotal": 0, "regulars": [ { "userId": "string", "name": null, "weeks": 0, "days": 0, "lastSeenAt": "2019-08-24T14:15:22Z" } ], "presenceReports": 0, "coverage": { "dailyTotalsFirstDay": null, "dailyTotalsLastDay": null, "dailyTotalsUpdatedAt": null, "factFirstDay": null, "factLastDay": null, "retentionConfigured": true, "moderationFactRetentionDays": 0, "presenceFactRetentionDays": 0 }, "generatedAt": "2019-08-24T14:15:22Z"}Get world analytics GET
Worlds: 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.
Get instance analytics GET
Instances: 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.