1. Supplier API
  • Supplier API
    • Guides
    • Get Global Definitions
      GET
    • Question Library Lookup
      GET
    • Question Library Answer Lookup
      GET
    • Get Available Surveys (all live surveys)
      GET
    • Get Available Surveys By Id
      GET
    • Get Survey Transactions Data
      GET
    • Get Survey Stats
      GET
  • Schemas
    • Sample Schemas
      • Pet
      • Category
      • Tag
  1. Supplier API

Get Available Surveys (all live surveys)

GET
https://supplierapi.survey-says.community/api/v1/supply/getAvailableSurveys
This API enables suppliers to retrieve the survey inventory linked to their accounts. The survey list will exclusively include surveys that are currently LIVE.

Request

Header Params

Responses

🟢200Success
application/json
Body

Example
{
    "apiStatus": "success",
    "msg": "All active assigned surveys are successfully searched",
    "result": [
        {
            "surveyId": 1,
            "survayName": "India",
            "N": 1,
            "CPI": 3,
            "remainingN": 1,
            "LOI": 1,
            "IR": 1,
            "Country": "India",
            "Language": "ENGLISH",
            "reContact": false,
            "surveyLiveURL": "https://www.example.com/screener?survey=z36mXYbQ&supplierId=2&pid=",
            "surveyTestURL": "https://www.example.com/screener?isTest=1&isLive=0&survey=z36mXYbQ&supplierId=2&pid=",
            "projectId": "1",
            "deviceType": "All",
            "projectCategory": "Automotive",
            "createdDate": "2024-09-10T11:21:53.152Z",
            "modifiedDate": "2024-09-10T12:39:41.832Z",
            "PII": false,
            "overAllCompletesAchieved": 0,
            "overAllStartsAchieved": 0,
            "actualIR": "",
            "actualLOI": "",
            "excluded_surveys": [
                2,
                3,
                4
            ],
            "excluded_status": [
                "Client Completes",
                "Client Fails",
                "Client OverQuota",
                "Client Quality Termination"
            ]
        }
    ]
}
Previous
Question Library Answer Lookup
Next
Get Available Surveys By Id
Built with