List audit log
/api/auditThe merged fact timeline: who did what to whom, and when. One log, discriminated by source (spec 5.9). ViewAuditLog covers moderation and membership history; ViewOperationalLog covers Modbot's own record — logins, settings changes, sync failures. The two are separate permissions and the filter is applied server-side on every query: asking for a type you cannot see omits it rather than refusing the request.
Facts carry occurredAt and, when the time is an inference rather than a statement, occurredBefore. precision says which, so a window is never rendered as an instant.
account is one Modbot account's whole history: facts about it — sign-ins, role changes, its password being reset — and facts it did, including every kick and ban pressed in Modbot. Both halves at once, because the log records the first against the subject and the second against the actor, and either alone is half the story. It narrows what you may already see: a caller with only ViewAuditLog gets the account's moderation actions, one with only ViewOperationalLog gets its sign-ins and role changes.
person is one person's whole history across every account Modbot can tie to the one named: facts about any of them and facts any of them did. personPlatform says which platform the id is on: VRChat (the default), Discord, or Modbot for a Modbot account id. Accounts are tied the way GET /api/people/lookup ties them, with your permissions: the linked Discord account needs ViewProfile and the Modbot account needs ViewOperationalLog or ManageUsers, and without them only the account you named is read.
show narrows to moderation (bans, kicks, warnings, turned-down requests, notes, case files, AutoMod and copied bans), presence (arrivals, leaves and avatars a companion saw) or discord (Discord's own log and every copy between the two platforms). Leave it out, or send everything, for all of it. GET /api/audit/filters lists which of the three each type is in.
notType leaves out the types it names, and can be combined with type.
world and instance narrow to one world or one VRChat instance number; category to Moderation or Operational; precision to Exact or Window; hasActor to facts somebody is named for, or not; q finds a word in the payload, the subject id or the actor id.
Paged by keyset. Send the returned next back as beforeOccurredAt + beforeId; both are required.
An API key, made on Settings, API keys. Every key starts with mbk_.
In: header
Query Parameters
uuiddate-timedate-timeAlso accepted as q.
date-timeint64int32Response Body
application/json
application/problem+json
application/problem+json
curl -X GET "https://example.com/api/audit"{ "entries": [ { "id": 0, "occurredAt": "2019-08-24T14:15:22Z", "occurredBefore": null, "observedAt": "2019-08-24T14:15:22Z", "precision": "Exact", "type": "string", "typeRaw": null, "category": "Moderation", "source": "string", "subjectPlatform": "string", "subjectId": "string", "subjectKind": "Person", "subjectName": null, "actorPlatform": null, "actorId": null, "actorName": null, "worldId": null, "worldName": null, "instanceId": null, "modbotInstanceId": null, "instanceName": null, "description": null, "data": null, "subjectTrustRank": null, "actorTrustRank": null, "linked": null, "reportedBy": null, "caseFileId": null, "reviewId": null } ], "next": null, "coverage": { "oldestFact": null, "firstObservedAt": null, "catchUpComplete": true }, "now": "2019-08-24T14:15:22Z"}Get a person's milestones GET
How many dates of calendar events one VRChat user came to, the date of the event Modbot calls their first moment (`firstAt`) and of the one that made them a Regular (`regularAt`), and the visit that ended their latest gap of the welcome-back length or more. Counted from the companion's presence reports, so only people in an instance where a moderator's app was present are counted. Needs ViewAuditLog, the permission that reads the same arrivals in the audit log.
Get audit log entry GET
One entry of the timeline, by its id. For a link to a single entry. An entry of a type this account may not read answers 404, the same as one that does not exist.