New API endpoints for wordlists and review queues
Today we just rolled out a suite of new API endpoints designed to improve the experience with our Wordlists and Review Queues for enterprise plans.
These enhancements offer greater flexibility if you're aiming to customise your moderation interface and leverage our robust moderation and review queue engine.
There's a lot to cover, so if this is interesting to you, I recommend to read the API reference here:
Updated Moderation API specs
What's new?
Review queues API endpoints
These endpoints offer robust tools for using review queues and can be seen as a way to consume the review queue instead of using the built in dashboard.
- Get a Queue: Retrieve detailed information about a specific review queue.
- Get Queue Items: Fetch a paginated list of items within a specific review queue, with various filtering options.
- Get Queue Statistics: Obtain statistics related to a specific review queue, including top reviewers and trend analysis.
- Resolve a Queue Item: Mark a specific item in the review queue as resolved.
- Unresolve a Queue Item: Reopen a previously resolved item in the review queue for further action.
Author insights API endpoints
The authors API provides endpoints to pull moderation related details about your users. For example, you can see how many violations a user has, their general reputation score, history, sentiment, and more.
- List Authors: Get a paginated list of authors with their activity metrics and reputation. Sort by
reputation,violationCount,reportCount,memberSince,lastActive,contentCount,flaggedContentRatio,averageSentiment - Author Details: Get detailed information about a specific author including historical data and analysis such as
activityHeatmap,riskAnalysis,sentimentTrends,contentAnalysis,history
Wordlist API endpoints
Our updated Wordlist APIs provide comprehensive tools to manage your wordlists efficiently. Here are some of the key additions:
- List wordlists: Retrieve a list of all wordlists associated with your organisation.
- Get wordlist: Fetch detailed information about a specific wordlist by its ID.
- Add words to wordlist: Add new words to an existing wordlist. Duplicate entries are automatically ignored to maintain list integrity.
- Remove words from wordlist: Remove specified words from an existing wordlist.
- Get embedding status: Check the current embedding progress status for a wordlist.
Use case examples
Custom UI for your moderators
With the new Review Queues API endpoints, you can easily create a moderation interface that fits your organisation's needs.
Using these endpoints, developers can build dashboards that let moderators manage and handle flagged content efficiently, but without the overhead of building and maintaining your own moderation and queue engine.
Pull data in to your analytics or internal dashboard
Leverage the Author Insights API to integrate moderation data into your existing analytics or internal dashboards.
By using the Author Details endpoint, you can gather comprehensive metrics on user behaviour, violation trends, and reputation scores without jumping between different platforms.
White label solutions
Everything you can do in Moderation API's review queue dashboard, you can now do using API endpoints. This allows you to create white label moderation solutions that seamlessly integrate with your platform's branding and user interface. This ensures a consistent user experience while maintaining high standards of content moderation tailored to your brand’s specific needs.
Support and feedback
We are committed to providing you with the best tools for content moderation. If you have any questions, encounter issues, or have suggestions for further improvements, please don't hesitate to contact our support team.
We look forward to seeing how these new API endpoints enhance your workflows and contribute to maintaining a safe and respectful online environment.
Happy Moderating!
