Modbot Docs
APIAPI referenceAnalytics

Get regulars and return rate

GET/api/analytics/regulars

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.

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

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.