JavaScript
import ModerationAPI from '@moderation-api/sdk';
const client = new ModerationAPI({
secretKey: process.env['MODAPI_SECRET_KEY'], // This is the default and can be omitted
});
const items = await client.queue.items.list('id');
console.log(items.items);import os
from moderation_api import ModerationAPI
client = ModerationAPI(
secret_key=os.environ.get("MODAPI_SECRET_KEY"), # This is the default and can be omitted
)
items = client.queue.items.list(
id="id",
)
print(items.items)require "moderation_api"
moderation_api = ModerationAPI::Client.new(secret_key: "My Secret Key")
items = moderation_api.queue.items.list("id")
puts(items)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use ModerationAPI\Client;
use ModerationAPI\Core\Exceptions\APIException;
$client = new Client(secretKey: getenv('MODAPI_SECRET_KEY') ?: 'My Secret Key');
try {
$items = $client->queue->items->list(
'id',
afterDate: 'afterDate',
authorID: 'authorId',
beforeDate: 'beforeDate',
conversationIDs: 'conversationIds',
filteredActionIDs: 'filteredActionIds',
includeResolved: 'includeResolved',
labels: 'labels',
pageNumber: 0,
pageSize: 0,
sortDirection: 'asc',
sortField: 'createdAt',
);
var_dump($items);
} catch (APIException $e) {
echo $e->getMessage();
}using System;
using ModerationApi;
using ModerationApi.Models.Queue.Items;
ModerationApiClient client = new();
ItemListParams parameters = new() { ID = "id" };
var items = await client.Queue.Items.List(parameters);
Console.WriteLine(items);{
"items": [
{
"id": "<string>",
"content": "<string>",
"labels": [
{
"label": "<string>",
"score": 123,
"flagged": true
}
],
"flagged": true,
"timestamp": 123,
"language": "<string>",
"conversationId": "<string>",
"authorId": "<string>",
"actions": [
{
"id": "<string>",
"name": "<string>",
"timestamp": 123,
"comment": "<string>",
"reviewer": "<string>"
}
],
"contentType": "<string>"
}
],
"pagination": {
"totalItems": 123,
"totalPages": 123,
"currentPage": 123,
"hasNextPage": true,
"hasPreviousPage": true
}
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}{
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Get queue items
Get paginated list of items in a moderation queue with filtering options
JavaScript
import ModerationAPI from '@moderation-api/sdk';
const client = new ModerationAPI({
secretKey: process.env['MODAPI_SECRET_KEY'], // This is the default and can be omitted
});
const items = await client.queue.items.list('id');
console.log(items.items);import os
from moderation_api import ModerationAPI
client = ModerationAPI(
secret_key=os.environ.get("MODAPI_SECRET_KEY"), # This is the default and can be omitted
)
items = client.queue.items.list(
id="id",
)
print(items.items)require "moderation_api"
moderation_api = ModerationAPI::Client.new(secret_key: "My Secret Key")
items = moderation_api.queue.items.list("id")
puts(items)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use ModerationAPI\Client;
use ModerationAPI\Core\Exceptions\APIException;
$client = new Client(secretKey: getenv('MODAPI_SECRET_KEY') ?: 'My Secret Key');
try {
$items = $client->queue->items->list(
'id',
afterDate: 'afterDate',
authorID: 'authorId',
beforeDate: 'beforeDate',
conversationIDs: 'conversationIds',
filteredActionIDs: 'filteredActionIds',
includeResolved: 'includeResolved',
labels: 'labels',
pageNumber: 0,
pageSize: 0,
sortDirection: 'asc',
sortField: 'createdAt',
);
var_dump($items);
} catch (APIException $e) {
echo $e->getMessage();
}using System;
using ModerationApi;
using ModerationApi.Models.Queue.Items;
ModerationApiClient client = new();
ItemListParams parameters = new() { ID = "id" };
var items = await client.Queue.Items.List(parameters);
Console.WriteLine(items);{
"items": [
{
"id": "<string>",
"content": "<string>",
"labels": [
{
"label": "<string>",
"score": 123,
"flagged": true
}
],
"flagged": true,
"timestamp": 123,
"language": "<string>",
"conversationId": "<string>",
"authorId": "<string>",
"actions": [
{
"id": "<string>",
"name": "<string>",
"timestamp": 123,
"comment": "<string>",
"reviewer": "<string>"
}
],
"contentType": "<string>"
}
],
"pagination": {
"totalItems": 123,
"totalPages": 123,
"currentPage": 123,
"hasNextPage": true,
"hasPreviousPage": true
}
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}{
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The queue ID
Query Parameters
Number of items per page
Page number to fetch
Available options:
createdAt, severity, reviewedAt Sort direction
Available options:
asc, desc Was this page helpful?
⌘I