tools.ozone.moderation.query Events
GET {{baseUrl}}/xrpc/tools.ozone.moderation.queryEvents?types=<string>&types=<string>&createdBy=<did>&sortDirection=desc&createdAfter=<dateTime>&createdBefore=<dateTime>&subject=<uri>&collections=<nsid>&collections=<nsid>&subjectType=<string>&includeAllUserRecords=<boolean>&limit=50&hasComment=<boolean>&comment=<string>&addedLabels=<string>&addedLabels=<string>&removedLabels=<string>&removedLabels=<string>&addedTags=<string>&addedTags=<string>&removedTags=<string>&removedTags=<string>&reportTypes=<string>&reportTypes=<string>&cursor=<string>
This endpoint is part of the Ozone moderation service APIs. Requests usually require authentication, are directed to the user's PDS intance, and proxied to the Ozone instance indicated by the DID in the service proxying header. Admin authenentication may also be possible, with request sent directly to the Ozone instance.
To learn more about calling atproto API endpoints like this one, see the API Hosts and Auth guide.
List moderation events related to a subject.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
types | string | The types of events (fully qualified string in the format of tools.ozone.moderation.defs#modEvent<name>) to filter by. If not specified, all events are returned. | |
types | string | The types of events (fully qualified string in the format of tools.ozone.moderation.defs#modEvent<name>) to filter by. If not specified, all events are returned. | |
createdBy | string | ||
sortDirection | string | Sort direction for the events. Defaults to descending order of created at timestamp. | |
createdAfter | string | Retrieve events created after a given timestamp | |
createdBefore | string | Retrieve events created before a given timestamp | |
subject | string | ||
collections | string | If specified, only events where the subject belongs to the given collections will be returned. When subjectType is set to 'account', this will be ignored. | |
collections | string | If specified, only events where the subject belongs to the given collections will be returned. When subjectType is set to 'account', this will be ignored. | |
subjectType | string | If specified, only events where the subject is of the given type (account or record) will be returned. When this is set to 'account' the 'collections' parameter will be ignored. When includeAllUserRecords or subject is set, this will be ignored. | |
includeAllUserRecords | string | If true, events on all record types (posts, lists, profile etc.) or records from given 'collections' param, owned by the did are returned. | |
limit | number | ||
hasComment | string | If true, only events with comments are returned | |
comment | string | If specified, only events with comments containing the keyword are returned | |
addedLabels | string | If specified, only events where all of these labels were added are returned | |
addedLabels | string | If specified, only events where all of these labels were added are returned | |
removedLabels | string | If specified, only events where all of these labels were removed are returned | |
removedLabels | string | If specified, only events where all of these labels were removed are returned | |
addedTags | string | If specified, only events where all of these tags were added are returned | |
addedTags | string | If specified, only events where all of these tags were added are returned | |
removedTags | string | If specified, only events where all of these tags were removed are returned | |
removedTags | string | If specified, only events where all of these tags were removed are returned | |
reportTypes | string | ||
reportTypes | string | ||
cursor | string |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"events":[{"id":"\u003cinteger\u003e","event":{"comment":"\u003cstring\u003e","durationInHours":"\u003cinteger\u003e","acknowledgeAccountSubjects":"\u003cboolean\u003e"},"subject":{"did":"\u003cdid\u003e"},"subjectBlobCids":["\u003cstring\u003e","\u003cstring\u003e"],"createdBy":"\u003cdid\u003e","createdAt":"\u003cdateTime\u003e","creatorHandle":"\u003cstring\u003e","subjectHandle":"\u003cstring\u003e"},{"id":"\u003cinteger\u003e","event":{"comment":"\u003cstring\u003e","durationInHours":"\u003cinteger\u003e","acknowledgeAccountSubjects":"\u003cboolean\u003e"},"subject":{"did":"\u003cdid\u003e"},"subjectBlobCids":["\u003cstring\u003e","\u003cstring\u003e"],"createdBy":"\u003cdid\u003e","createdAt":"\u003cdateTime\u003e","creatorHandle":"\u003cstring\u003e","subjectHandle":"\u003cstring\u003e"}],"cursor":"\u003cstring\u003e"}