Surveys
Retrieve Prodege surveys
Get Surveys for Panelist
Get the list of eligible Prodege surveys for a given Supplier Panelist ID (VPID).
Request URL
/get-surveys-for-user
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)
signature
String
Required to authenticate supplier call
vpid
String
Yes
The supplier’s static panelist ID
useragent
String
Yes
User’s useragent
ip
String
Yes
User’s IP (IPv4 Only)
Response Parameters
Parameter Name
Parameter Type
Description / Notes
return_status
String
The return status for this api call
surveys[]
array
List of member eligible surveys for given vpid.
surveys Model
Parameter Name
Parameter Type
Description / Notes
loi
Numeric
Integer, time to complete (in minutes): Ex: 10
CPI
Numeric
Payout to supplier for a successfully completed survey for given user (In USD), Ex: 4.15
projectid
Numeric
Uniquely identifies the project
surveyurl
String
Link survey respondents should be sent to for a given survey. Example:
https://www.prsrvy.com/g/survey-click?projectid=53160088&sourceid=6016&vpid=0hT4pQ0pOKawqKCxtWqRnqLUMx73&cpi=1.05&hsh=1a9c75b19eee9cdeb13f63629c69b97bad36833073eee21c00ea8ad78c4b0f2c
max_completes
Numeric
This indicates how many times a single panelist can complete the survey. Note: The majority of the time, this is set to 1 (a panelist can complete that project only once).
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.
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.
matched_base_questions
Array
Array of question IDs targeted by the survey that are a match for the given user.
inconclusive_base_questions
Array
Array of question IDs targeted by the survey for which a profile response is not known for the given user. Users will be profiled for those questions upon click unless the user is updated with a profile response via /update-user.
pmr_project_type_ids
Array
Can be used to identify recontact surveys (type ID 6) and Tracker surveys (type ID of 2).
Example Response
Age Requirements
The minimum age requirement for panelist participation in Prodege surveys is 13 for the US, CA, and UK, and 16 for all other countries. Any attempt by an underage panelist to access a survey will result in a DQ termination with the "Underage Panelist" term reason (term reason ID 41).
Quality Flags
A panelist may be flagged for quality reasons and restricted from some or all surveys.
Disabled Panelists
When this occurs, no surveys will be returned for the panelist in the surveys array and the message below will be included.
Note, flagged panelists that attempt to enter a survey will be redirected as a Quality DQ with dp=true appended to the redirect URL.
Limited Panelists
When this occurs, fewer surveys will be returned for the panelist in the surveys array and the message below will be included.
Note, at the time that a panelist is flagged, the panelist will be redirected as a Quality DQ with limited=true appended to the redirect URL.
Last updated