Skip to main content

tools.ozone.moderation.getRecord

GET 
/xrpc/tools.ozone.moderation.getRecord

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

Request​

Query Parameters

    uri at-urirequired
    cid cid

Responses​

OK

Schema

    uri at-urirequired
    cid cidrequired
    value required

    blobs

    object[]

    required

  • Array [

    • cid cidrequired
    mimeType stringrequired
    size integerrequired
    createdAt date-timerequired

    details

    object

    oneOf

    width integerrequired
    height integerrequired

    moderation

    object

    subjectStatus

    object

    id integerrequired

    subject

    object

    required

    oneOf

    did didrequired
    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[]

  • ]

    • labels

    object[]

  • Array [

    • ver integer
    src didrequired

    DID of the actor who created this label.

    uri urirequired

    AT URI of the record, repository (account), or other resource that this label applies to.

    cid cid

    Optionally, CID specifying the specific version of 'uri' resource this label applies to.

    val stringrequired

    Possible values: <= 128 characters

    The short string name of the value or type of this label.

    neg boolean

    If true, this is a negation label, overwriting a previous label.

    cts date-timerequired

    Timestamp when this label was created.

    exp date-time

    Timestamp at which this label expires (no longer applies).

    sig byte

    Signature of dag-cbor encoded label.

  • ]

    • indexedAt date-timerequired

    moderation

    object

    required

    subjectStatus

    object

    id integerrequired

    subject

    object

    required

    oneOf

    did didrequired
    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

    did didrequired
    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

  • ]

Loading...