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 By Id

GET
https://supplierapi.survey-says.community/api/v1/supply/getSurvey/{Survey ID}
This API allows suppliers to fetch a survey using its survey ID, regardless of its current status (i.e. live, paused, or closed).

Request

Path Params

Header Params

Responses

🟢200Success
application/json
Body

Example
{
    "apiStatus": "success",
    "msg": "Live Survey is successfully searched",
    "result": [
        {
            "surveyId": 1,
            "Status": "Live",
            "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",
            "isPIIRequired": false,
            "overAllCompletesAchieved": 0,
            "overAllStartsAchieved": 0,
            "actualIR": "",
            "actualLOI": "",
            "excluded_surveys": [
                2,
                3,
                4
            ],
            "excluded_status": [
                "Client Completes",
                "Client Fails",
                "Client OverQuota",
                "Client Quality Termination"
            ],
            "Qualifications": [
                {
                    "QuestionId": 2,
                    "QuestionKey": "GENDER",
                    "QuestionText": "What is your gender?",
                    "QuestionType": "Single Punch",
                    "QuestionCategory": "Demographic",
                    "Options": [
                        {
                            "OptionId": 1,
                            "OptionText": "Male"
                        },
                        {
                            "OptionId": 2,
                            "OptionText": "Female"
                        }
                    ]
                },
                {
                    "QuestionId": 1,
                    "QuestionKey": "AGE",
                    "QuestionText": "What is your age?",
                    "QuestionType": "Numeric Open Ended",
                    "QuestionCategory": "Demographic",
                    "Options": [
                        {
                            "OptionId": 1,
                            "ageStart": 18,
                            "ageEnd": 59
                        }
                    ]
                }
            ],
            "Quotas": [
                {
                    "id": 40852559,
                    "quotaName": "Male 18-24",
                    "title": "18 - 24 Male",
                    "quotaN": 2,
                    "hardStop": true,
                    "clk": 0,
                    "cmp": 0,
                    "hardStopType": 1,
                    "quotaStatus": "Open",
                    "RemainingN": 2,
                    "targeting": {
                        "AGE": [
                            {
                                "OptionId": 1,
                                "ageStart": 18,
                                "ageEnd": 24
                            }
                        ],
                        "GENDER": [
                            {
                                "OptionId": 1,
                                "OptionText": "Male"
                            }
                        ]
                    }
                },
                {
                    "id": 40852560,
                    "quotaName": "Male 25-34",
                    "title": "25 - 34 Male",
                    "quotaN": 4,
                    "hardStop": false,
                    "clk": 0,
                    "cmp": 0,
                    "hardStopType": 1,
                    "quotaStatus": "Open",
                    "RemainingN": 4,
                    "targeting": {
                        "AGE": [
                            {
                                "OptionId": 2,
                                "ageStart": 25,
                                "ageEnd": 34
                            }
                        ],
                        "GENDER": [
                            {
                                "OptionId": 1,
                                "OptionText": "Male"
                            }
                        ]
                    }
                },
                {
                    "id": 40852561,
                    "quotaName": "Male 35-49",
                    "title": "35 - 49 Male",
                    "quotaN": 5,
                    "hardStop": true,
                    "clk": 3,
                    "cmp": 3,
                    "hardStopType": 1,
                    "quotaStatus": "Open",
                    "RemainingN": 2,
                    "targeting": {
                        "AGE": [
                            {
                                "OptionId": 3,
                                "ageStart": 35,
                                "ageEnd": 49
                            }
                        ],
                        "GENDER": [
                            {
                                "OptionId": 1,
                                "OptionText": "Male"
                            }
                        ]
                    }
                }
            ]
        }
    ]
}
Previous
Get Available Surveys (all live surveys)
Next
Get Survey Transactions Data
Built with