Skip to content

README.md

Latest commit

 

History

History
269 lines (190 loc) · 44.8 KB

README.md

File metadata and controls

269 lines (190 loc) · 44.8 KB
Raw

Authors

Overview

Available Operations

list

List the authors of the project, with their status, trust level and content metrics. The list is paginated. By default, the authors that were active most recently come first.

Example Usage

from moderation_api import ModerationAPI
import os


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

    res = ma_client.authors.list(request={})

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter Type Required Description
request models.ListAuthorsRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ListAuthorsResponse

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 */*

create

Create a new author. Typically not needed as authors are created automatically when content is moderated.

Example Usage

from moderation_api import ModerationAPI, models
import os


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

    res = ma_client.authors.create(external_id="user-1092", name="Jamie Rivera", email="jamie@example.com", metadata=models.CreateAuthorMetadata(
        email_verified=True,
        is_paying_customer=False,
    ))

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
external_id str ✔️ External ID of the user, typically the ID of the author in your database.
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.
profile_picture OptionalNullable[str] ➖ URL of the author's profile picture
external_link OptionalNullable[str] ➖ URL of the author's external profile
name OptionalNullable[str] ➖ Author name or identifier
email OptionalNullable[str] ➖ Author email address
company OptionalNullable[str] ➖ The author's company or organization
metadata Optional[models.CreateAuthorMetadata] ➖ Additional metadata provided by your system. We recommend including any relevant information that may assist in the moderation process.
first_seen Optional[float] ➖ Timestamp when author first appeared
last_seen Optional[float] ➖ Timestamp of last activity
manual_trust_level OptionalNullable[float] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.PublicAuthor

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 */*

retrieve

Get detailed information about a specific author including historical data and analysis

Example Usage

from moderation_api import ModerationAPI
import os


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

    res = ma_client.authors.retrieve(id="<id>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
id str ✔️ Either external ID or the ID assigned by moderation API.
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.PublicAuthor

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 */*

update

Update the details of a specific author

Example Usage

from moderation_api import ModerationAPI, models
import os


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

    res = ma_client.authors.update(id="<id>", metadata=models.UpdateAuthorMetadata(
        identity_verified=True,
    ), manual_trust_level=2.0)

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
id str ✔️ Either external ID or the ID assigned by moderation API.
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.
profile_picture OptionalNullable[str] ➖ URL of the author's profile picture
external_link OptionalNullable[str] ➖ URL of the author's external profile
name OptionalNullable[str] ➖ Author name or identifier
email OptionalNullable[str] ➖ Author email address
company OptionalNullable[str] ➖ The author's company or organization
metadata Optional[models.UpdateAuthorMetadata] ➖ Additional metadata provided by your system. We recommend including any relevant information that may assist in the moderation process.
first_seen Optional[float] ➖ Timestamp when author first appeared
last_seen Optional[float] ➖ Timestamp of last activity
manual_trust_level OptionalNullable[float] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.PublicAuthor

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 */*

delete

Delete a specific author. This resets the author: status, blocks, trust level, metrics and action history are removed. The author is created again with a clean record the next time content is moderated for the same ID.

Example Usage

from moderation_api import ModerationAPI
import os


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

    res = ma_client.authors.delete(id="<id>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
id str ✔️ Either external ID or the ID assigned by moderation API.
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.DeleteAuthorResponse

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 */*