tools.ozone.inbox.defs

ozone-lexicons.bsky.social

Documentation

actionView object

A single moderation action taken against a subject.

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

expiresAt string datetime Optional

An RFC 3339 formatted timestamp.

id integer Required

Action ID (moderation event ID).

labels array of string Optional

Label values, for labelApplied/labelRemoved.

policies array of ref#policyView Optional

Policies applied by a takedown action.

reversedAt string datetime Optional

An RFC 3339 formatted timestamp.

scope string Optional

No description available.

Known values: network, app, labelOnly
type string Required

Public action type.

View raw schema 
{
  "description": "A single moderation action taken against a subject.",
  "properties": {
    "createdAt": {
      "format": "datetime",
      "type": "string"
    },
    "expiresAt": {
      "format": "datetime",
      "type": "string"
    },
    "id": {
      "description": "Action ID (moderation event ID).",
      "type": "integer"
    },
    "labels": {
      "description": "Label values, for labelApplied/labelRemoved.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "policies": {
      "description": "Policies applied by a takedown action.",
      "items": {
        "ref": "#policyView",
        "type": "ref"
      },
      "type": "array"
    },
    "reversedAt": {
      "format": "datetime",
      "type": "string"
    },
    "scope": {
      "knownValues": [
        "network",
        "app",
        "labelOnly"
      ],
      "type": "string"
    },
    "type": {
      "description": "Public action type.",
      "type": "string"
    }
  },
  "required": [
    "id",
    "type",
    "createdAt"
  ],
  "type": "object"
}
appealView object

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

Properties

appealableUntil string datetime Optional

An RFC 3339 formatted timestamp.

appealedAt string datetime Optional

An RFC 3339 formatted timestamp.

resolvedAt string datetime Optional

When the appeal's report was closed.

state string Required

No description available.

Known values: none, pending, resolved, superseded, expired
View raw schema 
{
  "description": "The state of the viewer's appeal against the actions on a subject.",
  "properties": {
    "appealableUntil": {
      "format": "datetime",
      "type": "string"
    },
    "appealedAt": {
      "format": "datetime",
      "type": "string"
    },
    "resolvedAt": {
      "description": "When the appeal's report was closed.",
      "format": "datetime",
      "type": "string"
    },
    "state": {
      "knownValues": [
        "none",
        "pending",
        "resolved",
        "superseded",
        "expired"
      ],
      "type": "string"
    }
  },
  "required": [
    "state"
  ],
  "type": "object"
}
enforcementView object

The current enforcement state of a subject.

Properties

expiresAt string datetime Optional

An RFC 3339 formatted timestamp.

labels array of string Optional

Active label values on the subject, excluding negated and expired labels.

scope string Optional

No description available.

Known values: network, app, labelOnly
state string Required

No description available.

Known values: none, labeled, removed, suspended, takendown
View raw schema 
{
  "description": "The current enforcement state of a subject.",
  "properties": {
    "expiresAt": {
      "format": "datetime",
      "type": "string"
    },
    "labels": {
      "description": "Active label values on the subject, excluding negated and expired labels.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "scope": {
      "knownValues": [
        "network",
        "app",
        "labelOnly"
      ],
      "type": "string"
    },
    "state": {
      "knownValues": [
        "none",
        "labeled",
        "removed",
        "suspended",
        "takendown"
      ],
      "type": "string"
    }
  },
  "required": [
    "state"
  ],
  "type": "object"
}
notification object

No description available.

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

id integer Required

No description available.

isRead boolean Required

No description available.

reason string Required

No description available.

Known values: reportResolved, reportReopened, actionTaken, actionReversed, appealResolved, standingChanged
View raw schema 
{
  "properties": {
    "createdAt": {
      "format": "datetime",
      "type": "string"
    },
    "id": {
      "type": "integer"
    },
    "isRead": {
      "type": "boolean"
    },
    "reason": {
      "knownValues": [
        "reportResolved",
        "reportReopened",
        "actionTaken",
        "actionReversed",
        "appealResolved",
        "standingChanged"
      ],
      "type": "string"
    },
    "target": {
      "refs": [
        "#reportRef",
        "#subjectRef",
        "#standingRef"
      ],
      "type": "union"
    }
  },
  "required": [
    "id",
    "reason",
    "target",
    "isRead",
    "createdAt"
  ],
  "type": "object"
}
notificationPreferences object

No description available.

Properties

push boolean Required

No description available.

View raw schema 
{
  "properties": {
    "push": {
      "type": "boolean"
    }
  },
  "required": [
    "push"
  ],
  "type": "object"
}
policyView object

No description available.

Properties

displayName string Required

No description available.

key string Required

No description available.

View raw schema 
{
  "properties": {
    "displayName": {
      "type": "string"
    },
    "key": {
      "type": "string"
    },
    "link": {
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "key",
    "displayName",
    "link"
  ],
  "type": "object"
}
reportRef object

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

Properties

reportId integer Required

No description available.

status string Optional

No description available.

Known values: pending, resolved
View raw schema 
{
  "description": "Reference to a report by its report table ID, as used by getReport and Ozone's report detail page.",
  "properties": {
    "reportId": {
      "type": "integer"
    },
    "status": {
      "knownValues": [
        "pending",
        "resolved"
      ],
      "type": "string"
    },
    "subject": {
      "refs": [
        "com.atproto.admin.defs#repoRef",
        "com.atproto.repo.strongRef"
      ],
      "type": "union"
    }
  },
  "required": [
    "reportId"
  ],
  "type": "object"
}
reportsSummary object

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

Properties

firstReportedOn string datetime Required

Day of the earliest report, truncated to midnight UTC. Render as a date; the time component is not meaningful.

lastReportedOn string datetime Required

Day of the most recent report, truncated to midnight UTC. Render as a date; the time component is not meaningful.

reasonTypes array of string Required

Distinct reason types reported, deduplicated and unordered. Excludes reasonAppeal.

View raw schema 
{
  "description": "Aggregate view of reports filed against this subject. Deliberately carries no report IDs, no count, and no reporter identities.",
  "properties": {
    "firstReportedOn": {
      "description": "Day of the earliest report, truncated to midnight UTC. Render as a date; the time component is not meaningful.",
      "format": "datetime",
      "type": "string"
    },
    "lastReportedOn": {
      "description": "Day of the most recent report, truncated to midnight UTC. Render as a date; the time component is not meaningful.",
      "format": "datetime",
      "type": "string"
    },
    "reasonTypes": {
      "description": "Distinct reason types reported, deduplicated and unordered. Excludes reasonAppeal.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "reasonTypes",
    "firstReportedOn",
    "lastReportedOn"
  ],
  "type": "object"
}
standingRef object

No description available.

Properties

previousStanding string Optional

No description available.

Known values: good, warning, atRisk
standing string Required

No description available.

Known values: good, warning, atRisk
View raw schema 
{
  "properties": {
    "previousStanding": {
      "knownValues": [
        "good",
        "warning",
        "atRisk"
      ],
      "type": "string"
    },
    "standing": {
      "knownValues": [
        "good",
        "warning",
        "atRisk"
      ],
      "type": "string"
    }
  },
  "required": [
    "standing"
  ],
  "type": "object"
}
subjectRef object

No description available.

Properties

actionId integer Optional

No description available.

actionType string Optional

No description available.

View raw schema 
{
  "properties": {
    "actionId": {
      "type": "integer"
    },
    "actionType": {
      "type": "string"
    },
    "subject": {
      "refs": [
        "com.atproto.admin.defs#repoRef",
        "com.atproto.repo.strongRef"
      ],
      "type": "union"
    }
  },
  "required": [
    "subject"
  ],
  "type": "object"
}
subjectView object

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

Properties

actionCount integer Optional

No description available.

appeal ref #appealView Optional

No description available.

availableActions array of string Optional

No description available.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

isRead boolean Required

No description available.

latestAction ref #actionView Optional

No description available.

src string did Required

DID of the moderation service that took the actions.

updatedAt string datetime Required

An RFC 3339 formatted timestamp.

View raw schema 
{
  "description": "A subject belonging to the viewer that has moderation actions against it.",
  "properties": {
    "actionCount": {
      "type": "integer"
    },
    "appeal": {
      "ref": "#appealView",
      "type": "ref"
    },
    "availableActions": {
      "items": {
        "knownValues": [
          "appeal"
        ],
        "type": "string"
      },
      "type": "array"
    },
    "createdAt": {
      "format": "datetime",
      "type": "string"
    },
    "enforcement": {
      "ref": "#enforcementView",
      "type": "ref"
    },
    "isRead": {
      "type": "boolean"
    },
    "latestAction": {
      "ref": "#actionView",
      "type": "ref"
    },
    "src": {
      "description": "DID of the moderation service that took the actions.",
      "format": "did",
      "type": "string"
    },
    "subject": {
      "refs": [
        "com.atproto.admin.defs#repoRef",
        "com.atproto.repo.strongRef"
      ],
      "type": "union"
    },
    "updatedAt": {
      "format": "datetime",
      "type": "string"
    }
  },
  "required": [
    "src",
    "subject",
    "enforcement",
    "isRead",
    "createdAt",
    "updatedAt"
  ],
  "type": "object"
}
subjectViewDetail object

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.

Properties

actions array of ref#actionView Required

A page of action history, most recent first. Reversal timestamps include changes outside this page.

maxLength: 100 items
appeal ref #appealView Optional

No description available.

availableActions array of string Optional

No description available.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

cursor string Optional

Cursor for the next page of action history. Omitted when no older actions remain.

isRead boolean Required

No description available.

record unknown Optional

Raw record JSON for the subject, when the subject is a record and the record is available.

reports ref #reportsSummary Optional

Omitted when the subject has never been reported, e.g. proactive enforcement.

src string did Required

A decentralized identifier (DID).

updatedAt string datetime Required

An RFC 3339 formatted timestamp.

View raw schema 
{
  "description": "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.",
  "properties": {
    "actions": {
      "description": "A page of action history, most recent first. Reversal timestamps include changes outside this page.",
      "items": {
        "ref": "#actionView",
        "type": "ref"
      },
      "maxLength": 100,
      "type": "array"
    },
    "appeal": {
      "ref": "#appealView",
      "type": "ref"
    },
    "availableActions": {
      "items": {
        "knownValues": [
          "appeal"
        ],
        "type": "string"
      },
      "type": "array"
    },
    "createdAt": {
      "format": "datetime",
      "type": "string"
    },
    "cursor": {
      "description": "Cursor for the next page of action history. Omitted when no older actions remain.",
      "type": "string"
    },
    "enforcement": {
      "ref": "#enforcementView",
      "type": "ref"
    },
    "isRead": {
      "type": "boolean"
    },
    "record": {
      "description": "Raw record JSON for the subject, when the subject is a record and the record is available.",
      "type": "unknown"
    },
    "reports": {
      "description": "Omitted when the subject has never been reported, e.g. proactive enforcement.",
      "ref": "#reportsSummary",
      "type": "ref"
    },
    "src": {
      "format": "did",
      "type": "string"
    },
    "subject": {
      "refs": [
        "com.atproto.admin.defs#repoRef",
        "com.atproto.repo.strongRef"
      ],
      "type": "union"
    },
    "updatedAt": {
      "format": "datetime",
      "type": "string"
    }
  },
  "required": [
    "src",
    "subject",
    "enforcement",
    "isRead",
    "actions",
    "createdAt",
    "updatedAt"
  ],
  "type": "object"
}

Lexicon Garden

@