tools.ozone.moderation.getEvent

GET 
/xrpc/tools.ozone.moderation.getEvent

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.

Get details about a moderation event.

Request

Query Parameters

id integerrequired

Responses

200

OK

application/json

Schema

Schema

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

tools.ozone.moderation.defs.repoView

did didrequired

handle handlerequired

email string

relatedRecords undefined[]required

indexedAt date-timerequired

moderation

object

required

subjectStatus

object

id integerrequired

subject

object

required

oneOf

com.atproto.admin.defs.repoRef

did didrequired

com.atproto.repo.strongRef

uri at-urirequired

cid cidrequired

subjectBlobCids cid[]

subjectRepoHandle string

updatedAt date-timerequired

Timestamp referencing when the last update was made to the moderation status of the subject

createdAt date-timerequired

Timestamp referencing the first moderation status impacting event was emitted on the subject

reviewState tools.ozone.moderation.defs.subjectReviewStaterequired

Possible values: [#reviewOpen, #reviewEscalated, #reviewClosed, #reviewNone]

comment string

Sticky comment on the subject.

muteUntil date-time

muteReportingUntil date-time

lastReviewedBy did

lastReviewedAt date-time

lastReportedAt date-time

lastAppealedAt date-time

Timestamp referencing when the author of the subject appealed a moderation action

takendown boolean

appealed boolean

True indicates that the a previously taken moderator action was appealed against, by the author of the content. False indicates last appeal was resolved by moderators.

suspendUntil date-time

tags string[]

invitedBy

object

code stringrequired

available integerrequired

disabled booleanrequired

forAccount stringrequired

createdBy stringrequired

createdAt date-timerequired

uses

object[]

required

Array [

usedBy didrequired

usedAt date-timerequired

]

invitesDisabled boolean

inviteNote string

deactivatedAt date-time

threatSignatures

object[]

Array [

property stringrequired

value stringrequired

]

tools.ozone.moderation.defs.repoViewNotFound

did didrequired

tools.ozone.moderation.defs.recordView

uri at-urirequired

cid cidrequired

value required

blobCids cid[]required

indexedAt date-timerequired

moderation

object

required

subjectStatus

object

id integerrequired

subject

object

required

oneOf

com.atproto.admin.defs.repoRef

did didrequired

com.atproto.repo.strongRef

uri at-urirequired

cid cidrequired

subjectBlobCids cid[]

subjectRepoHandle string

updatedAt date-timerequired

Timestamp referencing when the last update was made to the moderation status of the subject

createdAt date-timerequired

Timestamp referencing the first moderation status impacting event was emitted on the subject

reviewState tools.ozone.moderation.defs.subjectReviewStaterequired

Possible values: [#reviewOpen, #reviewEscalated, #reviewClosed, #reviewNone]

comment string

Sticky comment on the subject.

muteUntil date-time

muteReportingUntil date-time

lastReviewedBy did

lastReviewedAt date-time

lastReportedAt date-time

lastAppealedAt date-time

Timestamp referencing when the author of the subject appealed a moderation action

takendown boolean

appealed boolean

True indicates that the a previously taken moderator action was appealed against, by the author of the content. False indicates last appeal was resolved by moderators.

suspendUntil date-time

tags string[]

repo

object

required

did didrequired

handle handlerequired

email string

relatedRecords undefined[]required

indexedAt date-timerequired

moderation

object

required

subjectStatus

object

id integerrequired

subject

object

required

oneOf

com.atproto.admin.defs.repoRef

did didrequired

com.atproto.repo.strongRef

uri at-urirequired

cid cidrequired

subjectBlobCids cid[]

subjectRepoHandle string

updatedAt date-timerequired

Timestamp referencing when the last update was made to the moderation status of the subject

createdAt date-timerequired

Timestamp referencing the first moderation status impacting event was emitted on the subject

reviewState tools.ozone.moderation.defs.subjectReviewStaterequired

Possible values: [#reviewOpen, #reviewEscalated, #reviewClosed, #reviewNone]

comment string

Sticky comment on the subject.

muteUntil date-time

muteReportingUntil date-time

lastReviewedBy did

lastReviewedAt date-time

lastReportedAt date-time

lastAppealedAt date-time

Timestamp referencing when the author of the subject appealed a moderation action

takendown boolean

appealed boolean

True indicates that the a previously taken moderator action was appealed against, by the author of the content. False indicates last appeal was resolved by moderators.

suspendUntil date-time

tags string[]

invitedBy

object

code stringrequired

available integerrequired

disabled booleanrequired

forAccount stringrequired

createdBy stringrequired

createdAt date-timerequired

uses

object[]

required

Array [

usedBy didrequired

usedAt date-timerequired

]

invitesDisabled boolean

inviteNote string

deactivatedAt date-time

threatSignatures

object[]

Array [

property stringrequired

value stringrequired

]

tools.ozone.moderation.defs.recordViewNotFound

uri at-urirequired

subjectBlobs

object[]

required

Array [

cid cidrequired

mimeType stringrequired

size integerrequired

createdAt date-timerequired

details

object

oneOf

tools.ozone.moderation.defs.imageDetails

width integerrequired

height integerrequired

tools.ozone.moderation.defs.videoDetails

width integerrequired

height integerrequired

length integerrequired

moderation

object

subjectStatus

object

id integerrequired

subject

object

required

oneOf

com.atproto.admin.defs.repoRef

did didrequired

com.atproto.repo.strongRef

uri at-urirequired

cid cidrequired

subjectBlobCids cid[]

subjectRepoHandle string

updatedAt date-timerequired

Timestamp referencing when the last update was made to the moderation status of the subject

createdAt date-timerequired

Timestamp referencing the first moderation status impacting event was emitted on the subject

reviewState tools.ozone.moderation.defs.subjectReviewStaterequired

Possible values: [#reviewOpen, #reviewEscalated, #reviewClosed, #reviewNone]

comment string

Sticky comment on the subject.

muteUntil date-time

muteReportingUntil date-time

lastReviewedBy did

lastReviewedAt date-time

lastReportedAt date-time

lastAppealedAt date-time

Timestamp referencing when the author of the subject appealed a moderation action

takendown boolean

appealed boolean

True indicates that the a previously taken moderator action was appealed against, by the author of the content. False indicates last appeal was resolved by moderators.

suspendUntil date-time

tags string[]

]

createdBy didrequired
createdAt date-timerequired

Example (from schema)

{
  "id": 0,
  "event": {},
  "subject": {},
  "subjectBlobs": [
    {
      "cid": "string",
      "mimeType": "string",
      "size": 0,
      "createdAt": "2024-11-04T00:29:30.276Z",
      "details": {},
      "moderation": {
        "subjectStatus": {
          "id": 0,
          "subject": {},
          "subjectBlobCids": [
            "string"
          ],
          "subjectRepoHandle": "string",
          "updatedAt": "2024-11-04T00:29:30.276Z",
          "createdAt": "2024-11-04T00:29:30.276Z",
          "reviewState": "#reviewOpen",
          "comment": "string",
          "muteUntil": "2024-11-04T00:29:30.276Z",
          "muteReportingUntil": "2024-11-04T00:29:30.276Z",
          "lastReviewedBy": "string",
          "lastReviewedAt": "2024-11-04T00:29:30.276Z",
          "lastReportedAt": "2024-11-04T00:29:30.276Z",
          "lastAppealedAt": "2024-11-04T00:29:30.276Z",
          "takendown": true,
          "appealed": true,
          "suspendUntil": "2024-11-04T00:29:30.276Z",
          "tags": [
            "string"
          ]
        }
      }
    }
  ],
  "createdBy": "string",
  "createdAt": "2024-11-04T00:29:30.276Z"
}

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...