tools.ozone.moderation.queryEvents

GET 
/xrpc/tools.ozone.moderation.queryEvents

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

Query Parameters

types string[]

The types of events (fully qualified string in the format of tools.ozone.moderation.defs#modEvent) to filter by. If not specified, all events are returned.

createdBy did
sortDirection string

Default value: desc

Sort direction for the events. Defaults to descending order of created at timestamp.

createdAfter date-time

Retrieve events created after a given timestamp

createdBefore date-time

Retrieve events created before a given timestamp

subject uri
collections nsid[]

Possible values: <= 20

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

Possible values: [account, record]

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 boolean

If true, events on all record types (posts, lists, profile etc.) or records from given 'collections' param, owned by the did are returned.

limit integer

Possible values: >= 1 and <= 100

Default value: 50

hasComment boolean

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

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

removedTags string[]

If specified, only events where all of these tags were removed are returned

reportTypes string[]
cursor string

Responses

200

OK

application/json

Schema

Schema

cursor string

events

object[]

required

Array [

id integerrequired

event

object

required

oneOf

tools.ozone.moderation.defs.modEventTakedown

comment string

durationInHours integer

acknowledgeAccountSubjects boolean

If true, all other reports on content authored by this account will be resolved (acknowledged).

tools.ozone.moderation.defs.modEventReverseTakedown

comment string

Describe reasoning behind the reversal.

tools.ozone.moderation.defs.modEventComment

comment stringrequired

sticky boolean

Make the comment persistent on the subject

tools.ozone.moderation.defs.modEventReport

comment string

isReporterMuted boolean

Set to true if the reporter was muted from reporting at the time of the event. These reports won't impact the reviewState of the subject.

reportType

object

required

oneOf

com.atproto.moderation.defs.reasonSpam

string

com.atproto.moderation.defs.reasonViolation

string

com.atproto.moderation.defs.reasonMisleading

string

com.atproto.moderation.defs.reasonSexual

string

com.atproto.moderation.defs.reasonRude

string

com.atproto.moderation.defs.reasonOther

string

com.atproto.moderation.defs.reasonAppeal

string

tools.ozone.moderation.defs.modEventLabel

comment string

createLabelVals string[]required

negateLabelVals string[]required

tools.ozone.moderation.defs.modEventAcknowledge

comment string

tools.ozone.moderation.defs.modEventEscalate

comment string

tools.ozone.moderation.defs.modEventMute

comment string

durationInHours integerrequired

tools.ozone.moderation.defs.modEventUnmute

comment string

Describe reasoning behind the reversal.

tools.ozone.moderation.defs.modEventMuteReporter

comment string

durationInHours integerrequired

tools.ozone.moderation.defs.modEventUnmuteReporter

comment string

Describe reasoning behind the reversal.

tools.ozone.moderation.defs.modEventEmail

subjectLine stringrequired

The subject line of the email sent to the user.

content string

The content of the email sent to the user.

comment string

Additional comment about the outgoing comm.

tools.ozone.moderation.defs.modEventResolveAppeal

comment string

Describe resolution.

tools.ozone.moderation.defs.modEventDivert

comment string

tools.ozone.moderation.defs.modEventTag

add string[]required

remove string[]required

comment string

Additional comment about added/removed tags.

subject

object

required

oneOf

com.atproto.admin.defs.repoRef

did didrequired

com.atproto.repo.strongRef

uri at-urirequired

cid cidrequired

chat.bsky.convo.defs.messageRef

did didrequired

convoId stringrequired

messageId stringrequired

subjectBlobCids string[]required

createdBy didrequired

createdAt date-timerequired

creatorHandle string

subjectHandle string

]

Example (from schema)

{
  "cursor": "string",
  "events": [
    {
      "id": 0,
      "event": {},
      "subject": {},
      "subjectBlobCids": [
        "string"
      ],
      "createdBy": "string",
      "createdAt": "2024-11-07T00:27:32.167Z",
      "creatorHandle": "string",
      "subjectHandle": "string"
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

error stringrequired

Possible values: [InvalidRequest, ExpiredToken, InvalidToken]

message stringrequired

Example (from schema)

{
  "error": "InvalidRequest",
  "message": "string"
}

401

Unauthorized

application/json

Schema

Schema

error required
message stringrequired

Example (from schema)

{
  "message": "string"
}

Loading...