Skip to main content
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 queue = await client.queue.retrieve('id');

console.log(queue.queue);
{
  "queue": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "filter": {
      "conversationIds": [
        "<string>"
      ],
      "filterLabels": [
        {
          "label": "<string>",
          "type": "FLAGGED",
          "minThreshold": 50,
          "maxThreshold": 50
        }
      ],
      "labels": [
        "<string>"
      ],
      "afterDate": "<string>",
      "beforeDate": "<string>",
      "showChecked": true,
      "authorID": "<string>",
      "filteredActionIds": [
        "<string>"
      ],
      "filteredChannelIds": [
        "<string>"
      ],
      "recommendationActions": [
        "review"
      ]
    },
    "unresolvedItemsCount": 123,
    "resolvedItemsCount": 123,
    "totalItemsCount": 123
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The queue ID

Response

Successful response

queue
object
required