View moderation statuses of subjects (record or repo).
Parameters
ageAssuranceState
string
Optional
If specified, only subjects with the given age assurance state will be returned.
appealed
boolean
Optional
Get subjects in unresolved appealed status
collections
array
of string
Optional
If specified, subjects belonging to the given collections will be returned. When subjectType is set to 'account', this will be ignored.
comment
string
Optional
Search subjects by keyword from comments
cursor
string
Optional
No description available.
excludeTags
array
of string
Optional
No description available.
hostingDeletedAfter
string
datetime
Optional
Search subjects where the associated record/account was deleted after a given timestamp
hostingDeletedBefore
string
datetime
Optional
Search subjects where the associated record/account was deleted before a given timestamp
hostingStatuses
array
of string
Optional
Search subjects by the status of the associated record/account
hostingUpdatedAfter
string
datetime
Optional
Search subjects where the associated record/account was updated after a given timestamp
hostingUpdatedBefore
string
datetime
Optional
Search subjects where the associated record/account was updated before a given timestamp
ignoreSubjects
array
of string
Optional
No description available.
includeAllUserRecords
boolean
Optional
All subjects, or subjects from given 'collections' param, belonging to the account specified in the 'subject' param will be returned.
includeMuted
boolean
Optional
By default, we don't include muted subjects in the results. Set this to true to include them.
lastReviewedBy
string
did
Optional
Get all subject statuses that were reviewed by a specific moderator
limit
integer
Optional
No description available.
minAccountSuspendCount
integer
Optional
If specified, only subjects that belong to an account that has at least this many suspensions will be returned.
minPriorityScore
integer
Optional
If specified, only subjects that have priority score value above the given value will be returned.
minReportedRecordsCount
integer
Optional
If specified, only subjects that belong to an account that has at least this many reported records will be returned.
minStrikeCount
integer
Optional
If specified, only subjects that belong to an account that has at least this many active strikes will be returned.
minTakendownRecordsCount
integer
Optional
If specified, only subjects that belong to an account that has at least this many taken down records will be returned.
onlyMuted
boolean
Optional
When set to true, only muted subjects and reporters will be returned.
queueCount
integer
Optional
Number of queues being used by moderators. Subjects will be split among all queues.
queueIndex
integer
Optional
Index of the queue to fetch subjects from. Works only when queueCount value is specified.
queueSeed
string
Optional
A seeder to shuffle/balance the queue items.
reportedAfter
string
datetime
Optional
Search subjects reported after a given timestamp
reportedBefore
string
datetime
Optional
Search subjects reported before a given timestamp
reviewState
string
Optional
Specify when fetching subjects in a certain state
reviewedAfter
string
datetime
Optional
Search subjects reviewed after a given timestamp
reviewedBefore
string
datetime
Optional
Search subjects reviewed before a given timestamp
sortDirection
string
Optional
No description available.
sortField
string
Optional
No description available.
subject
string
uri
Optional
The subject to get the status for.
subjectType
string
Optional
If specified, subjects of the given type (account or record) will be returned. When this is set to 'account' the 'collections' parameter will be ignored. When includeAllUserRecords or subject is set, this will be ignored.
tags
array
of string
Optional
No description available.
takendown
boolean
Optional
Get subjects that were taken down
Output
application/jsoncursor
string
Optional
No description available.
subjectStatuses
array
Required
No description available.
Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"type": "query",
"output": {
"schema": {
"type": "object",
"required": [
"subjectStatuses"
],
"properties": {
"cursor": {
"type": "string"
},
"subjectStatuses": {
"type": "array",
"items": {
"ref": "tools.ozone.moderation.defs#subjectStatusView",
"type": "ref"
}
}
}
},
"encoding": "application/json"
},
"parameters": {
"type": "params",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string",
"description": "Items in this array are applied with OR filters. To apply AND filter, put all tags in the same string and separate using && characters"
},
"maxLength": 25
},
"limit": {
"type": "integer",
"default": 50,
"maximum": 100,
"minimum": 1
},
"cursor": {
"type": "string"
},
"comment": {
"type": "string",
"description": "Search subjects by keyword from comments"
},
"subject": {
"type": "string",
"format": "uri",
"description": "The subject to get the status for."
},
"appealed": {
"type": "boolean",
"description": "Get subjects in unresolved appealed status"
},
"onlyMuted": {
"type": "boolean",
"description": "When set to true, only muted subjects and reporters will be returned."
},
"queueSeed": {
"type": "string",
"description": "A seeder to shuffle/balance the queue items."
},
"sortField": {
"enum": [
"lastReviewedAt",
"lastReportedAt",
"reportedRecordsCount",
"takendownRecordsCount",
"priorityScore"
],
"type": "string",
"default": "lastReportedAt"
},
"takendown": {
"type": "boolean",
"description": "Get subjects that were taken down"
},
"queueCount": {
"type": "integer",
"description": "Number of queues being used by moderators. Subjects will be split among all queues."
},
"queueIndex": {
"type": "integer",
"description": "Index of the queue to fetch subjects from. Works only when queueCount value is specified."
},
"collections": {
"type": "array",
"items": {
"type": "string",
"format": "nsid"
},
"maxLength": 20,
"description": "If specified, subjects belonging to the given collections will be returned. When subjectType is set to 'account', this will be ignored."
},
"excludeTags": {
"type": "array",
"items": {
"type": "string"
}
},
"reviewState": {
"type": "string",
"description": "Specify when fetching subjects in a certain state",
"knownValues": [
"tools.ozone.moderation.defs#reviewOpen",
"tools.ozone.moderation.defs#reviewClosed",
"tools.ozone.moderation.defs#reviewEscalated",
"tools.ozone.moderation.defs#reviewNone"
]
},
"subjectType": {
"type": "string",
"description": "If specified, subjects of the given type (account or record) will be returned. When this is set to 'account' the 'collections' parameter will be ignored. When includeAllUserRecords or subject is set, this will be ignored.",
"knownValues": [
"account",
"record"
]
},
"includeMuted": {
"type": "boolean",
"description": "By default, we don't include muted subjects in the results. Set this to true to include them."
},
"reportedAfter": {
"type": "string",
"format": "datetime",
"description": "Search subjects reported after a given timestamp"
},
"reviewedAfter": {
"type": "string",
"format": "datetime",
"description": "Search subjects reviewed after a given timestamp"
},
"sortDirection": {
"enum": [
"asc",
"desc"
],
"type": "string",
"default": "desc"
},
"ignoreSubjects": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
},
"lastReviewedBy": {
"type": "string",
"format": "did",
"description": "Get all subject statuses that were reviewed by a specific moderator"
},
"minStrikeCount": {
"type": "integer",
"minimum": 1,
"description": "If specified, only subjects that belong to an account that has at least this many active strikes will be returned."
},
"reportedBefore": {
"type": "string",
"format": "datetime",
"description": "Search subjects reported before a given timestamp"
},
"reviewedBefore": {
"type": "string",
"format": "datetime",
"description": "Search subjects reviewed before a given timestamp"
},
"hostingStatuses": {
"type": "array",
"items": {
"type": "string"
},
"description": "Search subjects by the status of the associated record/account"
},
"minPriorityScore": {
"type": "integer",
"maximum": 100,
"minimum": 0,
"description": "If specified, only subjects that have priority score value above the given value will be returned."
},
"ageAssuranceState": {
"type": "string",
"description": "If specified, only subjects with the given age assurance state will be returned.",
"knownValues": [
"pending",
"assured",
"unknown",
"reset",
"blocked"
]
},
"hostingDeletedAfter": {
"type": "string",
"format": "datetime",
"description": "Search subjects where the associated record/account was deleted after a given timestamp"
},
"hostingUpdatedAfter": {
"type": "string",
"format": "datetime",
"description": "Search subjects where the associated record/account was updated after a given timestamp"
},
"hostingDeletedBefore": {
"type": "string",
"format": "datetime",
"description": "Search subjects where the associated record/account was deleted before a given timestamp"
},
"hostingUpdatedBefore": {
"type": "string",
"format": "datetime",
"description": "Search subjects where the associated record/account was updated before a given timestamp"
},
"includeAllUserRecords": {
"type": "boolean",
"description": "All subjects, or subjects from given 'collections' param, belonging to the account specified in the 'subject' param will be returned."
},
"minAccountSuspendCount": {
"type": "integer",
"description": "If specified, only subjects that belong to an account that has at least this many suspensions will be returned."
},
"minReportedRecordsCount": {
"type": "integer",
"description": "If specified, only subjects that belong to an account that has at least this many reported records will be returned."
},
"minTakendownRecordsCount": {
"type": "integer",
"description": "If specified, only subjects that belong to an account that has at least this many taken down records will be returned."
}
}
},
"description": "View moderation statuses of subjects (record or repo)."
}