tools.ozone.moderation.defs
#modEventView
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
id | integer | - | ✅ | - |
event | union of #modEventTakedown #modEventReverseTakedown #modEventComment #modEventReport #modEventLabel #modEventAcknowledge #modEventEscalate #modEventMute #modEventUnmute #modEventMuteReporter #modEventUnmuteReporter #modEventEmail #modEventResolveAppeal #modEventDivert #modEventTag #accountEvent #identityEvent #recordEvent #modEventPriorityScore | - | ✅ | - |
subject | union of com.atproto.admin.defs#repoRef com.atproto.repo.strongRef chat.bsky.convo.defs#messageRef | - | ✅ | - |
subjectBlobCids | array of string | - | ✅ | - |
createdBy | string (did) | - | ✅ | - |
createdAt | string (datetime) | - | ✅ | - |
creatorHandle | string | - | ❌ | - |
subjectHandle | string | - | ❌ | - |
#modEventViewDetail
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
id | integer | - | ✅ | - |
event | union of #modEventTakedown #modEventReverseTakedown #modEventComment #modEventReport #modEventLabel #modEventAcknowledge #modEventEscalate #modEventMute #modEventUnmute #modEventMuteReporter #modEventUnmuteReporter #modEventEmail #modEventResolveAppeal #modEventDivert #modEventTag #accountEvent #identityEvent #recordEvent #modEventPriorityScore | - | ✅ | - |
subject | union of #repoView #repoViewNotFound #recordView #recordViewNotFound | - | ✅ | - |
subjectBlobs | array of #blobView | - | ✅ | - |
createdBy | string (did) | - | ✅ | - |
createdAt | string (datetime) | - | ✅ | - |
#subjectStatusView
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
id | integer | - | ✅ | - |
subject | union of com.atproto.admin.defs#repoRef com.atproto.repo.strongRef | - | ✅ | - |
hosting | union of #accountHosting #recordHosting | - | ❌ | - |
subjectBlobCids | array of string | - | ❌ | - |
subjectRepoHandle | string | - | ❌ | - |
updatedAt | string (datetime) | - | ✅ | Timestamp referencing when the last update was made to the moderation status of the subject |
createdAt | string (datetime) | - | ✅ | Timestamp referencing the first moderation status impacting event was emitted on the subject |
reviewState | #subjectReviewState | - | ✅ | - |
comment | string | - | ❌ | Sticky comment on the subject. |
priorityScore | integer | - | ❌ | Numeric value representing the level of priority. Higher score means higher priority. |
muteUntil | string (datetime) | - | ❌ | - |
muteReportingUntil | string (datetime) | - | ❌ | - |
lastReviewedBy | string (did) | - | ❌ | - |
lastReviewedAt | string (datetime) | - | ❌ | - |
lastReportedAt | string (datetime) | - | ❌ | - |
lastAppealedAt | string (datetime) | - | ❌ | 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 | string (datetime) | - | ❌ | - |
tags | array of string | - | ❌ | - |
accountStats | #accountStats | - | ❌ | - |
recordsStats | #recordsStats | - | ❌ | - |
#subjectView
Detailed view of a subject. For record subjects, the author's repo and profile will be returned.
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
type | com.atproto.moderation.defs#subjectType | - | ✅ | - |
subject | string | - | ✅ | - |
status | #subjectStatusView | - | ❌ | - |
repo | #repoViewDetail | - | ❌ | - |
profile | union of | - | ❌ | - |
record | #recordViewDetail | - | ❌ | - |
#accountStats
Statistics about a particular account subject
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
reportCount | integer | - | ❌ | Total number of reports on the account |
appealCount | integer | - | ❌ | Total number of appeals against a moderation action on the account |
suspendCount | integer | - | ❌ | Number of times the account was suspended |
escalateCount | integer | - | ❌ | Number of times the account was escalated |
takedownCount | integer | - | ❌ | Number of times the account was taken down |
#recordsStats
Statistics about a set of record subject items
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
totalReports | integer | - | ❌ | Cumulative sum of the number of reports on the items in the set |
reportedCount | integer | - | ❌ | Number of items that were reported at least once |
escalatedCount | integer | - | ❌ | Number of items that were escalated at least once |
appealedCount | integer | - | ❌ | Number of items that were appealed at least once |
subjectCount | integer | - | ❌ | Total number of item in the set |
pendingCount | integer | - | ❌ | Number of item currently in "reviewOpen" or "reviewEscalated" state |
processedCount | integer | - | ❌ | Number of item currently in "reviewNone" or "reviewClosed" state |
takendownCount | integer | - | ❌ | Number of item currently taken down |
#subjectReviewState
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
subjectReviewState | string | #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
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
comment | string | - | ❌ | - |
durationInHours | integer | - | ❌ | Indicates how long the takedown should be in effect before automatically expiring. |
acknowledgeAccountSubjects | boolean | - | ❌ | If true, all other reports on content authored by this account will be resolved (acknowledged). |
policies | array of string | - | ❌ | Names/Keywords of the policies that drove the decision. |
#modEventReverseTakedown
Revert take down action on a subject
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
comment | string | - | ❌ | Describe reasoning behind the reversal. |
#modEventResolveAppeal
Resolve appeal on a subject
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
comment | string | - | ❌ | Describe resolution. |
#modEventComment
Add a comment to a subject. An empty comment will clear any previously set sticky comment.
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
comment | string | - | ❌ | - |
sticky | boolean | - | ❌ | Make the comment persistent on the subject |
#modEventReport
Report a subject
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
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 | com.atproto.moderation.defs#reasonType | - | ✅ | - |
#modEventLabel
Apply/Negate labels on a subject
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
comment | string | - | ❌ | - |
createLabelVals | array of string | - | ✅ | - |
negateLabelVals | array of string | - | ✅ | - |
durationInHours | integer | - | ❌ | 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.
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
comment | string | - | ❌ | - |
score | integer | - | ✅ | - |
#modEventAcknowledge
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
comment | string | - | ❌ | - |
acknowledgeAccountSubjects | boolean | - | ❌ | If true, all other reports on content authored by this account will be resolved (acknowledged). |
#modEventEscalate
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
comment | string | - | ❌ | - |
#modEventMute
Mute incoming reports on a subject
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
comment | string | - | ❌ | - |
durationInHours | integer | - | ✅ | Indicates how long the subject should remain muted. |
#modEventUnmute
Unmute action on a subject
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
comment | string | - | ❌ | Describe reasoning behind the reversal. |
#modEventMuteReporter
Mute incoming reports from an account
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
comment | string | - | ❌ | - |
durationInHours | integer | - | ❌ | Indicates how long the account should remain muted. Falsy value here means a permanent mute. |
#modEventUnmuteReporter
Unmute incoming reports from an account
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
comment | string | - | ❌ | Describe reasoning behind the reversal. |
#modEventEmail
Keep a log of outgoing email to a user
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
subjectLine | string | - | ✅ | 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. |
#modEventDivert
Divert a record's blobs to a 3rd party service for further scanning/tagging
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
comment | string | - | ❌ | - |
#modEventTag
Add/Remove a tag on a subject
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
add | array of string | - | ✅ | Tags to be added to the subject. If already exists, won't be duplicated. |
remove | array of string | - | ✅ | Tags to be removed to the subject. Ignores a tag If it doesn't exist, won't be duplicated. |
comment | string | - | ❌ | 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.
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
comment | string | - | ❌ | - |
active | boolean | - | ✅ | Indicates that the account has a repository which can be fetched from the host that emitted this event. |
status | string | unknown deactivated deleted takendown suspended tombstoned | ❌ | - |
timestamp | string (datetime) | - | ✅ | - |
#identityEvent
Logs identity related events on a repo subject. Normally captured by automod from the firehose and emitted to ozone for historical tracking.
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
comment | string | - | ❌ | - |
handle | string (handle) | - | ❌ | - |
pdsHost | string (uri) | - | ❌ | - |
tombstone | boolean | - | ❌ | - |
timestamp | string (datetime) | - | ✅ | - |
#recordEvent
Logs lifecycle event on a record subject. Normally captured by automod from the firehose and emitted to ozone for historical tracking.
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
comment | string | - | ❌ | - |
op | string | create update delete | ✅ | - |
cid | string (cid) | - | ❌ | - |
timestamp | string (datetime) | - | ✅ | - |
#repoView
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
did | string (did) | - | ✅ | - |
handle | string (handle) | - | ✅ | - |
string | - | ❌ | - | |
relatedRecords | array of unknown | - | ✅ | - |
indexedAt | string (datetime) | - | ✅ | - |
moderation | #moderation | - | ✅ | - |
invitedBy | com.atproto.server.defs#inviteCode | - | ❌ | - |
invitesDisabled | boolean | - | ❌ | - |
inviteNote | string | - | ❌ | - |
deactivatedAt | string (datetime) | - | ❌ | - |
threatSignatures | array of com.atproto.admin.defs#threatSignature | - | ❌ | - |
#repoViewDetail
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
did | string (did) | - | ✅ | - |
handle | string (handle) | - | ✅ | - |
string | - | ❌ | - | |
relatedRecords | array of unknown | - | ✅ | - |
indexedAt | string (datetime) | - | ✅ | - |
moderation | #moderationDetail | - | ✅ | - |
labels | array of com.atproto.label.defs#label | - | ❌ | - |
invitedBy | com.atproto.server.defs#inviteCode | - | ❌ | - |
invites | array of com.atproto.server.defs#inviteCode | - | ❌ | - |
invitesDisabled | boolean | - | ❌ | - |
inviteNote | string | - | ❌ | - |
emailConfirmedAt | string (datetime) | - | ❌ | - |
deactivatedAt | string (datetime) | - | ❌ | - |
threatSignatures | array of com.atproto.admin.defs#threatSignature | - | ❌ | - |
#repoViewNotFound
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
did | string (did) | - | ✅ | - |
#recordView
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
uri | string (at-uri) | - | ✅ | - |
cid | string (cid) | - | ✅ | - |
value | unknown | - | ✅ | - |
blobCids | array of string | - | ✅ | - |
indexedAt | string (datetime) | - | ✅ | - |
moderation | #moderation | - | ✅ | - |
repo | #repoView | - | ✅ | - |
#recordViewDetail
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
uri | string (at-uri) | - | ✅ | - |
cid | string (cid) | - | ✅ | - |
value | unknown | - | ✅ | - |
blobs | array of #blobView | - | ✅ | - |
labels | array of com.atproto.label.defs#label | - | ❌ | - |
indexedAt | string (datetime) | - | ✅ | - |
moderation | #moderationDetail | - | ✅ | - |
repo | #repoView | - | ✅ | - |
#recordViewNotFound
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
uri | string (at-uri) | - | ✅ | - |
#moderation
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
subjectStatus | #subjectStatusView | - | ❌ | - |
#moderationDetail
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
subjectStatus | #subjectStatusView | - | ❌ | - |
#blobView
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
cid | string (cid) | - | ✅ | - |
mimeType | string | - | ✅ | - |
size | integer | - | ✅ | - |
createdAt | string (datetime) | - | ✅ | - |
details | union of #imageDetails #videoDetails | - | ❌ | - |
moderation | #moderation | - | ❌ | - |
#imageDetails
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
width | integer | - | ✅ | - |
height | integer | - | ✅ | - |
#videoDetails
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
width | integer | - | ✅ | - |
height | integer | - | ✅ | - |
length | integer | - | ✅ | - |
#accountHosting
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
status | string | takendown suspended deleted deactivated unknown | ✅ | - |
updatedAt | string (datetime) | - | ❌ | - |
createdAt | string (datetime) | - | ❌ | - |
deletedAt | string (datetime) | - | ❌ | - |
deactivatedAt | string (datetime) | - | ❌ | - |
reactivatedAt | string (datetime) | - | ❌ | - |
#recordHosting
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
status | string | deleted unknown | ✅ | - |
updatedAt | string (datetime) | - | ❌ | - |
createdAt | string (datetime) | - | ❌ | - |
deletedAt | string (datetime) | - | ❌ | - |
#reporterStats
Property | Type | Known Values | Required | Description |
---|---|---|---|---|
did | string (did) | - | ✅ | - |
accountReportCount | integer | - | ✅ | The total number of reports made by the user on accounts. |
recordReportCount | integer | - | ✅ | The total number of reports made by the user on records. |
reportedAccountCount | integer | - | ✅ | The total number of accounts reported by the user. |
reportedRecordCount | integer | - | ✅ | The total number of records reported by the user. |
takendownAccountCount | integer | - | ✅ | The total number of accounts taken down as a result of the user's reports. |
takendownRecordCount | integer | - | ✅ | The total number of records taken down as a result of the user's reports. |
labeledAccountCount | integer | - | ✅ | The total number of accounts labeled as a result of the user's reports. |
labeledRecordCount | integer | - | ✅ | The total number of records labeled as a result of the user's reports. |