Overview - Partnership API Documentation

The Partnership API provides several key functionalities for managing surveys, including:

Updating Study Status: Modify the status of a study, such as STOP or IN_PROGRESS.

Publishing a Study: Launch a new survey, provided the partner has sufficient PopCoins balance.

Checking Study Details: Retrieve information about a specific study by its ID.

Generating CSV Report: Download a report for a study in CSV format.

Retrieving Criteria: Access available criteria for surveys, including age, gender, social economic status, and more.

The API uses a RESTful approach with standard HTTP methods such as GET, POST, PATCH, and DELETE. Authentication is required for all endpoints to ensure secure access.