How to Run a Report
This guide will walk you through the process of running a report using the WeCheck AI API, explaining the different endpoints you'll need to use along the way.
Step-by-Step Process
1. Select a Use Case
The start-search endpoint requires a use case parameter. Begin by retrieving all available use cases and selecting the appropriate one for your needs.
Important: If the selected use case requires compliance verification, make sure to set the compliance parameter to true in your start-search request.
2. Get Workspaces
The start-search endpoint also requires a team ID and workspace ID. Make a request to the get-workspaces endpoint to retrieve a list of your available teams and workspaces.
3. Get Topics (Optional)
You can enhance your search by including optional topics for targeted AI analysis. Adding specific topics allows our AI to focus on particular areas of interest within the social media content.
4. Run a Search
Complete the request body with the subject information and run a report using the start-search endpoint. Make sure to include all required parameters based on your selected use case.
5. Handle Compliance Requirements
If your selected use case requires compliance verification, you'll need to use one of these endpoints:
send-compliance-consent: Sends an email with the compliance form to the subjectupload-compliance: Uploads an already signed compliance document
Detailed API Reference
For detailed information about all available endpoints, parameters, responses, and code examples, please navigate to the API Reference tab in the navigation menu.
Need Help?
If you have any questions or need assistance, don't hesitate to contact our support team.