Skip to main content

tools.ozone.moderation.defs

#modEventView

PropertyTypeKnown ValuesRequiredDescription
idinteger--
eventunion of
#modEventTakedown
#modEventReverseTakedown
#modEventComment
#modEventReport
#modEventLabel
#modEventAcknowledge
#modEventEscalate
#modEventMute
#modEventUnmute
#modEventMuteReporter
#modEventUnmuteReporter
#modEventEmail
#modEventResolveAppeal
#modEventDivert
#modEventTag
#accountEvent
#identityEvent
#recordEvent
#modEventPriorityScore
--
subjectunion of
com.atproto.admin.defs#repoRef
com.atproto.repo.strongRef
chat.bsky.convo.defs#messageRef
--
subjectBlobCidsarray of string--
createdBystring (did)--
createdAtstring (datetime)--
creatorHandlestring--
subjectHandlestring--

#modEventViewDetail

PropertyTypeKnown ValuesRequiredDescription
idinteger--
eventunion of
#modEventTakedown
#modEventReverseTakedown
#modEventComment
#modEventReport
#modEventLabel
#modEventAcknowledge
#modEventEscalate
#modEventMute
#modEventUnmute
#modEventMuteReporter
#modEventUnmuteReporter
#modEventEmail
#modEventResolveAppeal
#modEventDivert
#modEventTag
#accountEvent
#identityEvent
#recordEvent
#modEventPriorityScore
--
subjectunion of
#repoView
#repoViewNotFound
#recordView
#recordViewNotFound
--
subjectBlobsarray of #blobView--
createdBystring (did)--
createdAtstring (datetime)--

#subjectStatusView

PropertyTypeKnown ValuesRequiredDescription
idinteger--
subjectunion of
com.atproto.admin.defs#repoRef
com.atproto.repo.strongRef
--
hostingunion of
#accountHosting
#recordHosting
--
subjectBlobCidsarray of string--
subjectRepoHandlestring--
updatedAtstring (datetime)-Timestamp referencing when the last update was made to the moderation status of the subject
createdAtstring (datetime)-Timestamp referencing the first moderation status impacting event was emitted on the subject
reviewState#subjectReviewState--
commentstring-Sticky comment on the subject.
priorityScoreinteger-Numeric value representing the level of priority. Higher score means higher priority.
muteUntilstring (datetime)--
muteReportingUntilstring (datetime)--
lastReviewedBystring (did)--
lastReviewedAtstring (datetime)--
lastReportedAtstring (datetime)--
lastAppealedAtstring (datetime)-Timestamp referencing when the author of the subject appealed a moderation action
takendownboolean--
appealedboolean-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.
suspendUntilstring (datetime)--
tagsarray of string--
accountStats#accountStats--
recordsStats#recordsStats--

#subjectView

Detailed view of a subject. For record subjects, the author's repo and profile will be returned.

PropertyTypeKnown ValuesRequiredDescription
typecom.atproto.moderation.defs#subjectType--
subjectstring--
status#subjectStatusView--
repo#repoViewDetail--
profileunion of
--
record#recordViewDetail--

#accountStats

Statistics about a particular account subject

PropertyTypeKnown ValuesRequiredDescription
reportCountinteger-Total number of reports on the account
appealCountinteger-Total number of appeals against a moderation action on the account
suspendCountinteger-Number of times the account was suspended
escalateCountinteger-Number of times the account was escalated
takedownCountinteger-Number of times the account was taken down

#recordsStats

Statistics about a set of record subject items

PropertyTypeKnown ValuesRequiredDescription
totalReportsinteger-Cumulative sum of the number of reports on the items in the set
reportedCountinteger-Number of items that were reported at least once
escalatedCountinteger-Number of items that were escalated at least once
appealedCountinteger-Number of items that were appealed at least once
subjectCountinteger-Total number of item in the set
pendingCountinteger-Number of item currently in "reviewOpen" or "reviewEscalated" state
processedCountinteger-Number of item currently in "reviewNone" or "reviewClosed" state
takendownCountinteger-Number of item currently taken down

#subjectReviewState

PropertyTypeKnown ValuesRequiredDescription
subjectReviewStatestring#reviewOpen
#reviewEscalated
#reviewClosed
#reviewNone
-

#reviewOpen

TOKEN: Moderator review status of a subject: Open. Indicates that the subject needs to be reviewed by a moderator

#reviewEscalated

TOKEN: Moderator review status of a subject: Escalated. Indicates that the subject was escalated for review by a moderator

#reviewClosed

TOKEN: Moderator review status of a subject: Closed. Indicates that the subject was already reviewed and resolved by a moderator

#reviewNone

TOKEN: Moderator review status of a subject: Unnecessary. Indicates that the subject does not need a review at the moment but there is probably some moderation related metadata available for it

#modEventTakedown

Take down a subject permanently or temporarily

PropertyTypeKnown ValuesRequiredDescription
commentstring--
durationInHoursinteger-Indicates how long the takedown should be in effect before automatically expiring.
acknowledgeAccountSubjectsboolean-If true, all other reports on content authored by this account will be resolved (acknowledged).
policiesarray of string-Names/Keywords of the policies that drove the decision.

#modEventReverseTakedown

Revert take down action on a subject

PropertyTypeKnown ValuesRequiredDescription
commentstring-Describe reasoning behind the reversal.

#modEventResolveAppeal

Resolve appeal on a subject

PropertyTypeKnown ValuesRequiredDescription
commentstring-Describe resolution.

#modEventComment

Add a comment to a subject. An empty comment will clear any previously set sticky comment.

PropertyTypeKnown ValuesRequiredDescription
commentstring--
stickyboolean-Make the comment persistent on the subject

#modEventReport

Report a subject

PropertyTypeKnown ValuesRequiredDescription
commentstring--
isReporterMutedboolean-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.
reportTypecom.atproto.moderation.defs#reasonType--

#modEventLabel

Apply/Negate labels on a subject

PropertyTypeKnown ValuesRequiredDescription
commentstring--
createLabelValsarray of string--
negateLabelValsarray of string--
durationInHoursinteger-Indicates how long the label will remain on the subject. Only applies on labels that are being added.

#modEventPriorityScore

Set priority score of the subject. Higher score means higher priority.

PropertyTypeKnown ValuesRequiredDescription
commentstring--
scoreinteger--

#modEventAcknowledge

PropertyTypeKnown ValuesRequiredDescription
commentstring--
acknowledgeAccountSubjectsboolean-If true, all other reports on content authored by this account will be resolved (acknowledged).

#modEventEscalate

PropertyTypeKnown ValuesRequiredDescription
commentstring--

#modEventMute

Mute incoming reports on a subject

PropertyTypeKnown ValuesRequiredDescription
commentstring--
durationInHoursinteger-Indicates how long the subject should remain muted.

#modEventUnmute

Unmute action on a subject

PropertyTypeKnown ValuesRequiredDescription
commentstring-Describe reasoning behind the reversal.

#modEventMuteReporter

Mute incoming reports from an account

PropertyTypeKnown ValuesRequiredDescription
commentstring--
durationInHoursinteger-Indicates how long the account should remain muted. Falsy value here means a permanent mute.

#modEventUnmuteReporter

Unmute incoming reports from an account

PropertyTypeKnown ValuesRequiredDescription
commentstring-Describe reasoning behind the reversal.

#modEventEmail

Keep a log of outgoing email to a user

PropertyTypeKnown ValuesRequiredDescription
subjectLinestring-The subject line of the email sent to the user.
contentstring-The content of the email sent to the user.
commentstring-Additional comment about the outgoing comm.

#modEventDivert

Divert a record's blobs to a 3rd party service for further scanning/tagging

PropertyTypeKnown ValuesRequiredDescription
commentstring--

#modEventTag

Add/Remove a tag on a subject

PropertyTypeKnown ValuesRequiredDescription
addarray of string-Tags to be added to the subject. If already exists, won't be duplicated.
removearray of string-Tags to be removed to the subject. Ignores a tag If it doesn't exist, won't be duplicated.
commentstring-Additional comment about added/removed tags.

#accountEvent

Logs account status related events on a repo subject. Normally captured by automod from the firehose and emitted to ozone for historical tracking.

PropertyTypeKnown ValuesRequiredDescription
commentstring--
activeboolean-Indicates that the account has a repository which can be fetched from the host that emitted this event.
statusstringunknown
deactivated
deleted
takendown
suspended
tombstoned
-
timestampstring (datetime)--

#identityEvent

Logs identity related events on a repo subject. Normally captured by automod from the firehose and emitted to ozone for historical tracking.

PropertyTypeKnown ValuesRequiredDescription
commentstring--
handlestring (handle)--
pdsHoststring (uri)--
tombstoneboolean--
timestampstring (datetime)--

#recordEvent

Logs lifecycle event on a record subject. Normally captured by automod from the firehose and emitted to ozone for historical tracking.

PropertyTypeKnown ValuesRequiredDescription
commentstring--
opstringcreate
update
delete
-
cidstring (cid)--
timestampstring (datetime)--

#repoView

PropertyTypeKnown ValuesRequiredDescription
didstring (did)--
handlestring (handle)--
emailstring--
relatedRecordsarray of unknown--
indexedAtstring (datetime)--
moderation#moderation--
invitedBycom.atproto.server.defs#inviteCode--
invitesDisabledboolean--
inviteNotestring--
deactivatedAtstring (datetime)--
threatSignaturesarray of com.atproto.admin.defs#threatSignature--

#repoViewDetail

PropertyTypeKnown ValuesRequiredDescription
didstring (did)--
handlestring (handle)--
emailstring--
relatedRecordsarray of unknown--
indexedAtstring (datetime)--
moderation#moderationDetail--
labelsarray of com.atproto.label.defs#label--
invitedBycom.atproto.server.defs#inviteCode--
invitesarray of com.atproto.server.defs#inviteCode--
invitesDisabledboolean--
inviteNotestring--
emailConfirmedAtstring (datetime)--
deactivatedAtstring (datetime)--
threatSignaturesarray of com.atproto.admin.defs#threatSignature--

#repoViewNotFound

PropertyTypeKnown ValuesRequiredDescription
didstring (did)--

#recordView

PropertyTypeKnown ValuesRequiredDescription
uristring (at-uri)--
cidstring (cid)--
valueunknown--
blobCidsarray of string--
indexedAtstring (datetime)--
moderation#moderation--
repo#repoView--

#recordViewDetail

PropertyTypeKnown ValuesRequiredDescription
uristring (at-uri)--
cidstring (cid)--
valueunknown--
blobsarray of #blobView--
labelsarray of com.atproto.label.defs#label--
indexedAtstring (datetime)--
moderation#moderationDetail--
repo#repoView--

#recordViewNotFound

PropertyTypeKnown ValuesRequiredDescription
uristring (at-uri)--

#moderation

PropertyTypeKnown ValuesRequiredDescription
subjectStatus#subjectStatusView--

#moderationDetail

PropertyTypeKnown ValuesRequiredDescription
subjectStatus#subjectStatusView--

#blobView

PropertyTypeKnown ValuesRequiredDescription
cidstring (cid)--
mimeTypestring--
sizeinteger--
createdAtstring (datetime)--
detailsunion of
#imageDetails
#videoDetails
--
moderation#moderation--

#imageDetails

PropertyTypeKnown ValuesRequiredDescription
widthinteger--
heightinteger--

#videoDetails

PropertyTypeKnown ValuesRequiredDescription
widthinteger--
heightinteger--
lengthinteger--

#accountHosting

PropertyTypeKnown ValuesRequiredDescription
statusstringtakendown
suspended
deleted
deactivated
unknown
-
updatedAtstring (datetime)--
createdAtstring (datetime)--
deletedAtstring (datetime)--
deactivatedAtstring (datetime)--
reactivatedAtstring (datetime)--

#recordHosting

PropertyTypeKnown ValuesRequiredDescription
statusstringdeleted
unknown
-
updatedAtstring (datetime)--
createdAtstring (datetime)--
deletedAtstring (datetime)--

#reporterStats

PropertyTypeKnown ValuesRequiredDescription
didstring (did)--
accountReportCountinteger-The total number of reports made by the user on accounts.
recordReportCountinteger-The total number of reports made by the user on records.
reportedAccountCountinteger-The total number of accounts reported by the user.
reportedRecordCountinteger-The total number of records reported by the user.
takendownAccountCountinteger-The total number of accounts taken down as a result of the user's reports.
takendownRecordCountinteger-The total number of records taken down as a result of the user's reports.
labeledAccountCountinteger-The total number of accounts labeled as a result of the user's reports.
labeledRecordCountinteger-The total number of records labeled as a result of the user's reports.