Skip to content

README.md

Latest commit

 

History

History
213 lines (149 loc) · 37.6 KB

README.md

File metadata and controls

213 lines (149 loc) · 37.6 KB
Raw

Queue.Items

Overview

Available Operations

list

List the items of a review queue, with the filters and the date window of the queue applied. By default only pending items. The list is paginated. Use the item id to resolve or unresolve an item.

Example Usage

from moderation_api import ModerationAPI
import os


with ModerationAPI(
    secret_key=os.getenv("MODAPI_SECRET_KEY", ""),
) as ma_client:

    res = ma_client.queue.items.list(id="<id>", page=1, page_size=20)

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter Type Required Description
id str ✔️ The queue ID.
page Optional[int] ➖ N/A
page_size Optional[int] ➖ N/A
sort Optional[models.Sort] ➖ N/A
include_resolved Optional[bool] ➖ N/A
conversation_ids List[str] ➖ N/A
labels List[str] ➖ N/A
author_id Optional[str] ➖ N/A
filtered_action_ids List[str] ➖ N/A
after_date Optional[str] ➖ N/A
before_date Optional[str] ➖ N/A
project_id Optional[str] ➖ The project to act on, by ID or name. Required with an organization key unless the key reaches only one project; list projects with GET /projects. A project key acts on its own project and needs no value: naming another one is an error.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ListQueueItemsResponse

Errors

Error Type Status Code Content Type
errors.BadRequestError 400 application/json
errors.AuthenticationError 401 application/json
errors.PermissionDeniedError 403 application/json
errors.NotFoundError 404 application/json
errors.RateLimitError 429 application/json
errors.InternalServerError 500 application/json
errors.ModerationAPIDefaultError 4XX, 5XX */*

resolve

Mark an item of a queue as resolved. It is the same as a check-off in the dashboard: the item leaves the pending list and a QUEUE_ITEM_COMPLETED webhook is sent. To also take a moderation action, use POST /actions/execute.

Example Usage

from moderation_api import ModerationAPI
import os


with ModerationAPI(
    secret_key=os.getenv("MODAPI_SECRET_KEY", ""),
) as ma_client:

    res = ma_client.queue.items.resolve(id="<id>", item_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
id str ✔️ The queue ID.
item_id str ✔️ The item ID to resolve.
project_id Optional[str] ➖ The project to act on, by ID or name. Required with an organization key unless the key reaches only one project; list projects with GET /projects. A project key acts on its own project and needs no value: naming another one is an error.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ResolveQueueItemResponse

Errors

Error Type Status Code Content Type
errors.BadRequestError 400 application/json
errors.AuthenticationError 401 application/json
errors.PermissionDeniedError 403 application/json
errors.RateLimitError 429 application/json
errors.InternalServerError 500 application/json
errors.ModerationAPIDefaultError 4XX, 5XX */*

resolve_many

Mark up to 100 items of a queue as resolved in one request. Each item is resolved the same as with POST /queue/{id}/items/{itemId}/resolve. IDs that do not exist in the project are skipped and returned in notFoundIds.

Example Usage

from moderation_api import ModerationAPI
import os


with ModerationAPI(
    secret_key=os.getenv("MODAPI_SECRET_KEY", ""),
) as ma_client:

    res = ma_client.queue.items.resolve_many(id="<id>", item_ids=[
        "clx8k2v0e000108l4a9bz3f7q",
        "clx8k2v0e000208l4h2mc6d1r",
    ])

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
id str ✔️ The queue ID.
item_ids List[str] ✔️ The item IDs to resolve. Up to 100.
project_id Optional[str] ➖ The project to act on, by ID or name. Required with an organization key unless the key reaches only one project; list projects with GET /projects. A project key acts on its own project and needs no value: naming another one is an error.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ResolveQueueItemsResponse

Errors

Error Type Status Code Content Type
errors.BadRequestError 400 application/json
errors.AuthenticationError 401 application/json
errors.PermissionDeniedError 403 application/json
errors.RateLimitError 429 application/json
errors.InternalServerError 500 application/json
errors.ModerationAPIDefaultError 4XX, 5XX */*

unresolve

Mark a resolved item of a queue as pending again. It is the same as removing a check-off in the dashboard: the item comes back in the pending list.

Example Usage

from moderation_api import ModerationAPI
import os


with ModerationAPI(
    secret_key=os.getenv("MODAPI_SECRET_KEY", ""),
) as ma_client:

    res = ma_client.queue.items.unresolve(id="<id>", item_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
id str ✔️ The queue ID.
item_id str ✔️ The item ID to unresolve.
project_id Optional[str] ➖ The project to act on, by ID or name. Required with an organization key unless the key reaches only one project; list projects with GET /projects. A project key acts on its own project and needs no value: naming another one is an error.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.UnresolveQueueItemResponse

Errors

Error Type Status Code Content Type
errors.BadRequestError 400 application/json
errors.AuthenticationError 401 application/json
errors.PermissionDeniedError 403 application/json
errors.RateLimitError 429 application/json
errors.InternalServerError 500 application/json
errors.ModerationAPIDefaultError 4XX, 5XX */*