Get instance activity
/api/analytics/instances/activityHow 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.
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/analytics/instances/activity"{ "range": "string", "from": "2019-08-24T14:15:22Z", "to": "2019-08-24T14:15:22Z", "stepSeconds": 0, "points": [ { "at": "2019-08-24T14:15:22Z", "people": 0, "instances": 0 } ], "generatedAt": "2019-08-24T14:15:22Z", "daysWithoutHeadCounts": [ "2019-08-24" ]}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.
Get the Discord bot's state GET
Where the Discord bot is: `NotConfigured`, `Connecting`, `Connected`, `Disconnected` or `Failed`; null when this server runs no bot. The word alone, for the Integrations page, so it needs ManageSettings rather than ViewOperationalLog. The bot's errors and counts stay in the sync health read. Needs the `ManageSettings` permission.