Skip to main content

tools.ozone.inbox.defs

#subjectView​

A subject belonging to the viewer that has moderation actions against it.

PropertyTypeKnown ValuesRequiredDescription
srcstring (did)-✅DID of the moderation service that took the actions.
subjectunion of
com.atproto.admin.defs#repoRef
com.atproto.repo.strongRef
-✅-
enforcement#enforcementView-✅-
appeal#appealView-❌-
availableActionsarray of string-❌-
latestAction#actionView-❌-
actionCountinteger-❌-
createdAtstring (datetime)-✅-
updatedAtstring (datetime)-✅-
isReadboolean-✅-

#enforcementView​

The current enforcement state of a subject.

PropertyTypeKnown ValuesRequiredDescription
statestringnone
labeled
removed
suspended
takendown
✅-
scopestringnetwork
app
labelOnly
❌-
expiresAtstring (datetime)-❌-
labelsarray of string-❌Active label values on the subject, excluding negated and expired labels.

#appealView​

The state of the viewer's appeal against the actions on a subject.

PropertyTypeKnown ValuesRequiredDescription
statestringnone
pending
resolved
superseded
expired
✅-
appealedAtstring (datetime)-❌-
resolvedAtstring (datetime)-❌When the appeal's report was closed.
outcomestringapproved
denied
❌Decision on a resolved appeal.
appealableUntilstring (datetime)-❌-

#actionView​

A single moderation action taken against a subject.

PropertyTypeKnown ValuesRequiredDescription
idinteger-✅Action ID (moderation event ID).
typestring-✅Public action type.
scopestringnetwork
app
labelOnly
❌-
createdAtstring (datetime)-✅-
reversedAtstring (datetime)-❌-
expiresAtstring (datetime)-❌-
labelsarray of string-❌Label values, for labelApplied/labelRemoved.
policiesarray of #policyView-❌Policies applied by a takedown action.

#policyView​

PropertyTypeKnown ValuesRequiredDescription
keystring-✅-
displayNamestring-✅-
linkstring (uri)-✅-

#subjectViewDetail​

A subject with a page of its action history and an aggregate report summary. Follow cursor to retrieve older actions; enforcement and appeal describe the current subject state on every page.

PropertyTypeKnown ValuesRequiredDescription
srcstring (did)-✅-
isReadboolean-✅-
subjectunion of
com.atproto.admin.defs#repoRef
com.atproto.repo.strongRef
-✅-
recordunknown-❌Raw record JSON for the subject, when the subject is a record and the record is available.
enforcement#enforcementView-✅-
appeal#appealView-❌-
availableActionsarray of string-❌-
actionsarray of #actionView-✅A page of action history, most recent first. Reversal timestamps include changes outside this page.
cursorstring-❌Cursor for the next page of action history. Omitted when no older actions remain.
reports#reportsSummary-❌-
createdAtstring (datetime)-✅-
updatedAtstring (datetime)-✅-

#reportsSummary​

Aggregate view of reports filed against this subject. Deliberately carries no report IDs, no count, and no reporter identities.

PropertyTypeKnown ValuesRequiredDescription
reasonTypesarray of string-✅Distinct reason types reported, deduplicated and unordered. Excludes reasonAppeal.
firstReportedOnstring (datetime)-✅Day of the earliest report, truncated to midnight UTC. Render as a date; the time component is not meaningful.
lastReportedOnstring (datetime)-✅Day of the most recent report, truncated to midnight UTC. Render as a date; the time component is not meaningful.

#notification​

PropertyTypeKnown ValuesRequiredDescription
idinteger-✅-
reasonstringreportResolved
reportReopened
actionTaken
actionReversed
appealResolved
standingChanged
✅-
targetunion of
#reportRef
#subjectRef
#standingRef
-✅-
isReadboolean-✅-
createdAtstring (datetime)-✅-

#notificationPreferences​

Push notification preferences by moderation notification category. These preferences do not hide in-app inbox activity. Each category defaults to enabled.

PropertyTypeKnown ValuesRequiredDescription
reportsboolean-✅Notify about outcomes of reports filed by the account (reportResolved and reportReopened).
accountboolean-✅Notify about moderation actions against the account or its content, action reversals, appeal outcomes, and standing changes. Label application and removal are controlled by labels.
labelsboolean-✅Notify when labels are applied to or removed from the account or its content (labelApplied and labelRemoved actions).

#reportRef​

Reference to a report by its report table ID, as used by getReport and Ozone's report detail page.

PropertyTypeKnown ValuesRequiredDescription
reportIdinteger-✅-
subjectunion of
com.atproto.admin.defs#repoRef
com.atproto.repo.strongRef
-❌-
statusstringpending
resolved
❌-

#subjectRef​

PropertyTypeKnown ValuesRequiredDescription
appealOutcomestringapproved
denied
❌Decision captured when an appealResolved notification was created. Omitted when the outcome is unknown.
subjectunion of
com.atproto.admin.defs#repoRef
com.atproto.repo.strongRef
-✅-
actionTypestring-❌-
actionIdinteger-❌-

#standingRef​

PropertyTypeKnown ValuesRequiredDescription
standingstringgood
warning
atRisk
✅-
previousStandingstringgood
warning
atRisk
❌-