Modbot Docs
APIAPI referenceCalendar

List past events

GET/api/calendar/past

Every time an event ran over the last days days (90 unless asked), the most at once first, at most 50. Each carries the same figures as one event's results, without who was seen.

Needs the ViewAnalytics and ViewCalendar permissions.

AuthorizationBearer <token>

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

In: header

Query Parameters

days?integer
Formatint32

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/api/calendar/past"
{  "occurrences": [    {      "eventId": "d6703cc8-9e79-415d-ac03-a4dc7f6ab43c",      "title": "string",      "startsAt": "2019-08-24T14:15:22Z",      "endsAt": "2019-08-24T14:15:22Z",      "instance": null,      "openedByModbot": true,      "newMembers": 0,      "joinRequests": 0,      "seen": null    }  ],  "from": "2019-08-24T14:15:22Z",  "now": "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.

Get what one time of an event did GET

One time an event ran, named by its start (`at`, as the calendar gives it): the instance it ran in, with the most at once and how long it ran as the instance popup has them; how many joined the group and how many asked to, from when the event opened until a day after it ended; and the middle value of each of those over the event's last earlier times. The instance is the one Modbot opened for that time. When Modbot opened none, it is the group's instance in the event's world that was open for most of the event. Who a moderator's client saw there (`occurrence.seen` and `people`) needs ViewAuditLog as well, as in the instance popup; without it `canSeeWhoWasThere` is false and both are empty. They exist only while a moderator's client was in the instance. 404 when the event has not run at that time. Needs the `ViewAnalytics` and `ViewCalendar` permissions.

Get how an event's dates did over time GET

Every date of one event that has a count or an opened instance, earliest first, at most the latest 100: how many people were interested on Discord and on VRChat when the date started, how many people a moderator's client saw arrive at its instance, and the most counted at once. Each interested count is written once, when the date starts; one read more than ten minutes later (Modbot was not running at the start) is marked late, and a date from before Modbot kept them has none. `came` counts only people seen where a moderator's client stood, so it can be lower than the real turnout, and is null for a date nobody was seen at. The averages are over the dates that have the figure. Needs the `ViewAnalytics` and `ViewCalendar` permissions.