Surveys

Retrieve available Prodege surveys

Get All Surveys

Get a list of the Prodege surveys available to a Supplier

Request URL	/get-surveys-for-vendor
Request Method	GET

Request Parameters

Parameter Name	Parameter Type	Required?	Description
apik	String	Yes	Key uniquely identifying the supplier
request_date	Numeric	Yes (in milliseconds)	See authentication
signature	String	Yes (see here)	Required to authenticate supplier call

Response Parameters

Parameter Name	Parameter Type	Description / Notes
return_status	String	The return status for this api call
surveys	array	List of panelist eligible surveys for given vpid.
surveys array
project_name	String	The name of the survey
country_code	String	The two letter country code of the country targeted by the survey. Ex: US This will be null if the survey is targeting multiple countries. In this case, a country_id will be defined at the quota level.
sample_size	Numeric	The total number of responses originally available for the survey. Ex: 100
loi	Numeric	Time to complete the survey (in minutes). Ex: 10
actual_ir	Numeric	The incidence rate of the survey. Ex: 85
conversion_rate	Numeric	The calculated conversion rate of this survey. Ex: 50.25
cpi	Numeric	Payout to supplier. Ex: 1.25
projectid	Numeric	The ID that uniquely identifies the survey. Ex: 12345
surveyurl	String	The link survey respondents should be sent to for a given survey. Ex: https://www.prsrvy.com/g/survey-click?projectid=53160088&sourceid=6016&cpi=1.05&hsh=1a9c75b19eee9cdeb13f63629c69b97bad36833073eee21c00ea8ad78c4b0f2c
max_clicks_settings	Array	Details about any click limiting that is enforced for the survey. For example, a survey may allow only 100 total clicks from all suppliers every 30 minutes.
max_clicks_settings array
max_clicks_cap	Numeric	The total number of clicks allowed before survey traffic is paused.
max_clicks_max_click_rate_id	Numeric	The refill rate id for clicks (1: every 30 min, 2: every 1 hour, 3: every 24 hours, 0: one-time setting).
max_clicks_allowed_clicks	Numeric	The current remaining number of clicks before survey traffic is paused.
phases	Array	The current phase of key survey metrics (e.g. LOI). Each metric can hold one of two potential values: bid or actual. bid: This value indicates that the metric is based on observed activity rather an estimate. actual: This value signifies that a sufficient level of activity has transpired, enabling the calculation of the metric.
past_participation	Array	Array of inclusions/exclusions by project ID. Only participants who meet the project participation requirements will be allowed to enter the survey. Note: If both past_participation and limited_panelists are present for a survey, a panelist must meet both requirements in order to eligible for the survey.
past_participation array
participation_project_ids	Array	List of project IDs that are included/excluded.
filter_type	String	The past participation requirement. Either exclude or include.
in_past_days	Numeric	The number of days for the inclusion or exclusion. If 0, the inclusion or exclusion should apply for all time. Example: If an exclusion was set to 1 day and it is currently Jan 2, anybody who participated on Jan 1 (any time) AND anybody who participated on the current day (any time Jan 2) would be excluded. Anybody who participated on Dec 31 would NOT be excluded.
participation_types	Array	The participation type(s) that are being included or excluded. Either click, complete, dq, or oq.
limited_panelists	Array	Array of included or excluded panelists (VPIDs). If present, only included panelists are eligible to participate and excluded panelists are not eligible to participate. Note: If both past_participation and limited_panelists are present for a survey, a panelist must meet both requirements in order to eligible for the survey.
limited_panelists
limit_type	String	The panelist requirement. Either exclude or include.
panelists_ids	Array	The list of included or excluded panelists (VPIDs).
quotas	Array	Array of quotas associated with the given survey.
quotas array
parent_quota_id	Numeric	The parent ID that uniquely identifies the quota. See Quotas below. Ex: 123456
quota_id	Numeric	The child ID that uniquely identifies the quota. See Quotas below. Ex: 123457
calculation_type	Numeric	When the quota sample size should be decremented. Possible values: 1 (Complete), 2 (Click).
country_id	Numeric	The country ID being targeted by the quota. This will only be present if the country_code is null in the survey details since the survey is targeting multiple countries.
sample_size	Numeric	The total number of responses originally available for the quota. Ex: 100
number_of_respondents	Numeric	The total number of allowed responses that remain from the total sample_size. Ex: 100
targeting_criteria	Object Array	The respondent qualifications that describe this quota.
targeting_criteria array
question_id	Numeric	The ID that uniquely identifies the targeting question (see Lookup Questions By CountryID). Ex: 3 (Gender)
operator	String	Possible values: OR, NOT, BETWEEN
precodes	String Array	Array of option IDs for the associated question that are accepted for this quota (see Lookup Questions By CountryID).

Example Response

{
   "surveys":[
      {
         "quotas":[
            {
               "quota_id":293427469,
               "calculation_type":1,
               "sample_size":1116,
               "targeting_criteria":[
                  {
                     "question_id":1,
                     "operator":"BETWEEN",
                     "precodes":[
                        "18",
                        "35"
                     ]
                  },
                  {
                     "question_id":445,
                     "operator":"OR",
                     "precodes":[
                        "1",
                        "2",
                        "3",
                        "4"
                     ]
                  }
               ]
            }
         ],
         "country_code":"US",
         "surveyurl":"https://www.prsrvy.com/g/survey-click?projectid=103511581&sourceid=6016&ft=1&cpi=0.94&hsh=91938c9228c7f77f32d212300b633ba32da943cbca2ff80d55dc0ac75750eb55",
         "past_participation":{
            "participation_project_ids":[
               108994063,
               112480233,
               117931567
            ],
            "filter_type":"exclude",
            "in_past_days":7,
            "participation_types":[
               "complete",
               "dq"
            ]
         },
         "loi":31,
         "max_clicks_settings":{
            "max_clicks_cap":1,
            "max_clicks_allowed_clicks":1,
            "max_clicks_max_click_rate_id":2
         },
         "sample_size":1116,
         "project_name":"Exciting Survey 04584",
         "projectid":103511581,
         "cpi":0.94,
         "phases":{
            "loi_phase":"bid",
            "actual_ir_phase":"bid"
         },
         "conversion_rate":19.0,
         "actual_ir":44
      },
      {
         "quotas":[
            {
               "quota_id":152502078,
               "parent_quota_id":0,
               "calculation_type":1,
               "sample_size":20,
               "number_of_respondents":20,
               "country_id":1,
               "targeting_criteria":[
                  {
                     "question_id":3,
                     "operator":"OR",
                     "precodes":[
                        "1",
                        "2",
                        "3"
                     ]
                  }
               ]
            }
         ],
         "country_code":null,
         "limited_panelists":{
            "limit_type":"include",
            "panelist_ids":[
               "46186",
               "45924",
               "46090",
               "46172",
               "46173"
            ]
         },
         "surveyurl":"https://answer.prsrvydv.com/g/survey-click?projectid=31688744&sourceid=6019&ft=1&cpi=3.5&hsh=e5ab370ad89d795bd7cfc0ebeb033f244f706b8da725ec70d2ae3af23cfdeee8",
         "loi":3,
         "sample_size":20,
         "project_name":"Exciting Survey 06423",
         "projectid":31688744,
         "cpi":3.5,
         "phases":{
            "loi_phase":"bid",
            "actual_ir_phase":"bid"
         },
         "conversion_rate":0.0,
         "actual_ir":60
      },
      {
         "quotas":[
            {
               "quota_id":290164548,
               "calculation_type":1,
               "sample_size":310,
               "targeting_criteria":[
                  {
                     "question_id":3,
                     "operator":"OR",
                     "precodes":[
                        "1",
                        "2"
                     ]
                  },
                  {
                     "question_id":738,
                     "operator":"NOT",
                     "precodes":[
                        "2"
                     ]
                  }
               ]
            }
         ],
         "country_code":"US",
         "surveyurl":"https://www.prsrvy.com/g/survey-click?projectid=102416546&sourceid=6016&ft=1&cpi=1.23&hsh=116a6034673d9cc32672b723b7b8e44bc6f393d1e171b7f2e03f419431749f43",
         "loi":30,
         "sample_size":310,
         "project_name":"Exciting Survey 01893",
         "projectid":102416546,
         "cpi":1.23,
         "phases":{
            "loi_phase":"actual",
            "actual_ir_phase":"bid"
         },
         "conversion_rate":7.0,
         "actual_ir":16
      }
   ],
   "return_status":{
      "status_id":1,
      "message":[
         "Request Successful"
      ]
   }
}