1. Supplier API
  • Supplier API
    • Guides
    • Get Global Definitions
      GET
    • Question Library
      GET
    • Answer Library
      GET
    • Get Available Surveys
      GET
    • Get Survey By Id
      GET
    • Get Survey Transactions Data
      GET
    • Get Survey Stats
      GET
    • Get Recontacts
      GET
  1. Supplier API

Get Survey By Id

GET
https://supplier.opnion.io/api/v1/supply/getSurvey/{Survey ID}
This API enables suppliers to retrieve details of a survey by its unique survey ID, regardless of whether the survey is active, paused, or closed.

Request

Path Params

Header Params

Responses

🟢200OK
application/json
Body

Example
{
    "apiStatus": "success",
    "msg": "Survey is successfully searched",
    "result": {
        "surveyId": 5158,
        "status": "Live",
        "survayName": "Test Survey",
        "N": 10,
        "CPI": 0,
        "remainingN": 10,
        "LOI": 10,
        "IR": 10,
        "Country": "India",
        "Language": "ENGLISH",
        "reContact": true,
        "surveyLiveURL": "https://www.example.com/screener?survey=GYOyWJPb&supplierId=124&pid=",
        "surveyTestURL": "https://www.example.com/screener?isTest=1&isLive=0&survey=GYOyWJPb&supplierId=124&pid=",
        "projectId": "1837",
        "deviceType": "All",
        "projectCategory": "Ailment",
        "createdDate": "2025-02-14T06:54:49.453Z",
        "modifiedDate": "2025-02-19T05:43:10.307Z",
        "PII": false,
        "overAllCompletesAchieved": 0,
        "overAllStartsAchieved": -1,
        "actualIR": 0,
        "actualLOI": 0,
        "excluded_surveys": [],
        "excluded_status": [],
        "Qualifications": [
            {
                "QuestionId": 2920,
                "QuestionKey": "Personal_Income_IN",
                "QuestionText": "What is your personal income, before tax?",
                "QuestionCategory": "Home",
                "QuestionType": "Single Punch",
                "Options": [
                    {
                        "OptionId": 1,
                        "OptionText": "No Income/Less than Rs.1,00,000"
                    },
                    {
                        "OptionId": 2,
                        "OptionText": "Rs.1,00,001 to Rs.3,00,000"
                    },
                    {
                        "OptionId": 3,
                        "OptionText": "Rs.3,00,001 to Rs.5,00,000"
                    },
                    {
                        "OptionId": 4,
                        "OptionText": "Rs.5,00,001 to Rs.7,00,000"
                    },
                    {
                        "OptionId": 5,
                        "OptionText": "Rs.7,00,001 to Rs.10,00,000"
                    },
                    {
                        "OptionId": 6,
                        "OptionText": "Rs.10,00,001 to Rs.15,00,000"
                    },
                    {
                        "OptionId": 7,
                        "OptionText": "Rs.15,00,001 and more"
                    },
                    {
                        "OptionId": 8,
                        "OptionText": "No Income"
                    },
                    {
                        "OptionId": 9,
                        "OptionText": "Don't know"
                    },
                    {
                        "OptionId": 10,
                        "OptionText": "Prefer not to say"
                    }
                ]
            },
            {
                "QuestionId": 2898,
                "QuestionKey": "STANDARD_URBAN_RURAL",
                "QuestionText": "Which of the following best describes the area you live in?",
                "QuestionCategory": "Demographic",
                "QuestionType": "Single Punch",
                "Options": [
                    {
                        "OptionId": 1,
                        "OptionText": "Urban – Densely populated, city or large town"
                    },
                    {
                        "OptionId": 2,
                        "OptionText": "Suburban – Mainly residential, bordering a city or large town"
                    },
                    {
                        "OptionId": 3,
                        "OptionText": "Rural – Sparsely populated, small town or village"
                    }
                ]
            }
        ],
        "Quotas": [
            {
                "id": 6502,
                "quotaName": "Income",
                "title": "No Income/Less than Rs.1,00,000 Rs.1,00,001 to Rs.3,00,000 Rs.3,00,001 to Rs.5,00,000 Rs.5,00,001 to Rs.7,00,000 Endometriosis Enlarged prostate/BPH Fibromyalgia Gout ",
                "quotaN": 1,
                "hardStop": true,
                "clk": 0,
                "cmp": 0,
                "hardStopType": 0,
                "quotaStatus": "Open",
                "RemainingN": 1,
                "targeting": {
                    "Personal_Income_IN": [
                        {
                            "OptionId": 1,
                            "OptionText": "No Income/Less than Rs.1,00,000"
                        },
                        {
                            "OptionId": 2,
                            "OptionText": "Rs.1,00,001 to Rs.3,00,000"
                        },
                        {
                            "OptionId": 3,
                            "OptionText": "Rs.3,00,001 to Rs.5,00,000"
                        },
                        {
                            "OptionId": 4,
                            "OptionText": "Rs.5,00,001 to Rs.7,00,000"
                        }
                    ],
                    "STANDARD_URBAN_RURAL": [
                        {
                            "OptionId": 1,
                            "OptionText": "Urban – Densely populated, city or large town"
                        }
                    ]
                }
            }
        ]
    }
}
Modified at 2025-02-19 07:00:40
Previous
Get Available Surveys
Next
Get Survey Transactions Data
Built with