Modbot Docs
APIAPI referenceAnalytics

Get world analytics

GET/api/analytics/worlds

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.

AuthorizationBearer <token>

An API key, made on Settings, API keys. Every key starts with mbk_.

In: header

Query Parameters

days?integer
Formatint32
all?boolean
from?string
Formatdate
to?string
Formatdate

Response 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"}

Modbot is not endorsed by or affiliated with VRChat Inc. or Discord Inc. VRChat is a trademark of VRChat Inc. Discord is a trademark of Discord Inc. SteamVR is a trademark of Valve Corporation. Windows is a trademark of Microsoft Corporation. Docker is a trademark of Docker, Inc. PostgreSQL is a trademark of the PostgreSQL Community Association of Canada. Railway is a trademark of Railway Corp. Other names are trademarks of their respective owners; see Legal. Modbot and its logo are trademarks of the Modbot project. Open source under AGPL-3.0.