Modbot Docs
APIAPI referenceAnalytics

Get group analytics

GET/api/analytics/group

The VRChat analytics page: is the community growing or shrinking, and what changed? Member count over time, joins and leaves per day, net change, roles, how long current members have been members, and whether invites turn into joins. Daily series come from modbot_daily_total, which is never aged out; the headcount, role changes and invite follow-up come from the fact log, which a retention window can shorten; tenure comes from the join dates on VRChat's member list. coverage reports both ranges.

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/group"
{  "from": "2019-08-24",  "to": "2019-08-24",  "today": null,  "memberCount": [    {      "day": "2019-08-24",      "value": 0.1    }  ],  "joined": [    {      "day": "2019-08-24",      "value": 0.1    }  ],  "left": [    {      "day": "2019-08-24",      "value": 0.1    }  ],  "netChange": [    {      "day": "2019-08-24",      "value": 0.1    }  ],  "invitesSent": [    {      "day": "2019-08-24",      "value": 0.1    }  ],  "requestsReceived": [    {      "day": "2019-08-24",      "value": 0.1    }  ],  "roles": [    {      "id": "string",      "name": null,      "isModerationRole": true,      "isAddedOnJoin": true,      "isSelfAssignable": true,      "granted": 0.1,      "revoked": 0.1    }  ],  "rolesKnownAt": null,  "tenure": [    {      "label": "string",      "minDays": 0,      "maxDays": null,      "members": 0    }  ],  "membersWithKnownTenure": 0,  "invites": {    "invitesSent": 0.1,    "joinedAfterInvite": 0,    "followUpDays": 0,    "requestsReceived": 0.1,    "requestsApproved": 0.1,    "requestsRejected": 0.1  },  "peaks": {    "members": null,    "online": null,    "coverage": {      "windowDays": 0,      "daysWithReadings": 0,      "readings": 0,      "thin": true    }  },  "daysWithoutAuditLog": [    "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.