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 response = await client.queue.getStats('id');
console.log(response.actionStats);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
)
response = client.queue.get_stats(
id="id",
)
print(response.action_stats)require "moderation_api"
moderation_api = ModerationAPI::Client.new(secret_key: "My Secret Key")
response = moderation_api.queue.get_stats("id")
puts(response)<?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 {
$response = $client->queue->getStats('id', withinDays: 'withinDays');
var_dump($response);
} catch (APIException $e) {
echo $e->getMessage();
}using System;
using ModerationApi;
using ModerationApi.Models.Queue;
ModerationApiClient client = new();
QueueGetStatsParams parameters = new() { ID = "id" };
var response = await client.Queue.GetStats(parameters);
Console.WriteLine(response);{
"reviewStats": {
"averageTimeToReview": 123,
"totalReviewed": 123,
"totalPending": 123
},
"actionStats": [
{
"actionId": "<string>",
"actionName": "<string>",
"count": 123,
"percentageOfTotal": 123
}
],
"topReviewers": [
{
"userId": "<string>",
"name": "<string>",
"reviewCount": 123,
"averageTimePerReview": 123,
"topActions": [
{
"actionId": "<string>",
"actionName": "<string>",
"count": 123
}
],
"accuracyScore": 123
}
],
"trends": {
"dailyReviewCounts": [
{
"date": "<string>",
"count": 123
}
],
"flaggedContentTrends": [
{
"label": "<string>",
"trend": 123
}
]
}
}{
"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 statistics
Get detailed statistics about a moderation queue including review times, action counts, and trends
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 response = await client.queue.getStats('id');
console.log(response.actionStats);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
)
response = client.queue.get_stats(
id="id",
)
print(response.action_stats)require "moderation_api"
moderation_api = ModerationAPI::Client.new(secret_key: "My Secret Key")
response = moderation_api.queue.get_stats("id")
puts(response)<?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 {
$response = $client->queue->getStats('id', withinDays: 'withinDays');
var_dump($response);
} catch (APIException $e) {
echo $e->getMessage();
}using System;
using ModerationApi;
using ModerationApi.Models.Queue;
ModerationApiClient client = new();
QueueGetStatsParams parameters = new() { ID = "id" };
var response = await client.Queue.GetStats(parameters);
Console.WriteLine(response);{
"reviewStats": {
"averageTimeToReview": 123,
"totalReviewed": 123,
"totalPending": 123
},
"actionStats": [
{
"actionId": "<string>",
"actionName": "<string>",
"count": 123,
"percentageOfTotal": 123
}
],
"topReviewers": [
{
"userId": "<string>",
"name": "<string>",
"reviewCount": 123,
"averageTimePerReview": 123,
"topActions": [
{
"actionId": "<string>",
"actionName": "<string>",
"count": 123
}
],
"accuracyScore": 123
}
],
"trends": {
"dailyReviewCounts": [
{
"date": "<string>",
"count": 123
}
],
"flaggedContentTrends": [
{
"label": "<string>",
"trend": 123
}
]
}
}{
"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 days to analyze statistics for
Was this page helpful?
⌘I