Partnership API Documentation
    Partnership API Documentation
    • Introduction
    • Overview
    • Flowchart
    • Authentication
    • Participant Criteria
    • Publish Study
    • APIs
      • Get Criteria
        GET
      • Publish Study
        POST
      • Get Study Details
        GET
      • Update Study Status
        PATCH
      • Get Study Report
        GET

    Flowchart

    This flowchart represents the sequence of actions in the Partnership API for managing surveys.
    The process includes the following steps:
    1.
    Retrieve Criteria
    Get available respondent criteria, including:
    Age
    Gender
    Social Economic Status
    Domicile
    Province
    And more
    2.
    Publish Study
    Launch a new survey. This action is permitted if the partner has a sufficient PopCoins balance.
    3.
    Check Study Details
    Retrieve details of the published study using its unique Study ID.
    4.
    Update Study Status to STOP
    Once the study is concluded or needs to be stopped, update its status to STOP.
    5.
    Generate CSV Report
    Download a comprehensive report of the study in CSV format.

    Partnership Flowchart
    Modified at 2025-04-14 10:24:33
    Previous
    Overview
    Next
    Authentication
    Built with