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)	See authentication
signature	String	Yes (see here)	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

{
    "surveys": [
        {
            "max_completes": 1,
            "pmr_project_type_ids": [],
            "matched_base_questions": [
                3
            ],
            "surveyurl": "https://prodegemr.prsrvydv.com/g/survey-click?projectid=32038120&sourceid=3046&vpid=9738bec7e75485814b19026399cb10fa&cpi=0.3&hsh=7402233ab943b91e5437201b94f6ad3d80298c267d36f2b23f8c9f12452814e5",
            "loi": 1,
            "inconclusive_base_questions": [],
            "project_name": "Exciting Survey 02084",
            "projectid": 32038120,
            "cpi": 0.3,
            "phases": {
                "loi_phase": "bid"
            }
        },
        {
            "max_completes": 1,
            "pmr_project_type_ids": [],
            "matched_base_questions": [
                3
            ],
            "surveyurl": "https://prodegemr.prsrvydv.com/g/survey-click?projectid=31769803&sourceid=3046&vpid=9738bec7e75485814b19026399cb10fa&cpi=1.5&hsh=5044a7917379709ead43b1f5057332f1ab8747567a6f8cb6316efe72d5568623",
            "loi": 2,
            "inconclusive_base_questions": [
                445
            ],
            "project_name": "Exciting Survey 07755",
            "projectid": 31769803,
            "cpi": 1.5,
            "phases": {
                "loi_phase": "bid"
            }
        },
        {
            "max_completes": 1,
            "pmr_project_type_ids": [],
            "matched_base_questions": [
                3
            ],
            "surveyurl": "https://prodegemr.prsrvydv.com/g/survey-click?projectid=31769684&sourceid=3046&vpid=9738bec7e75485814b19026399cb10fa&cpi=1.5&hsh=6dc80c389815ea6a307f872d84c46547ace0ab94b66df82a456aeae8982f8aa9",
            "loi": 2,
            "inconclusive_base_questions": [],
            "max_clicks_settings": {
                "max_clicks_cap": 1,
                "max_clicks_allowed_clicks": 1,
                "max_clicks_max_click_rate_id": 1
            },
            "project_name": "Exciting Survey 02272",
            "projectid": 31769684,
            "cpi": 1.5,
            "phases": {
                "loi_phase": "actual"
            }
        }
    ],
    "return_status": {
        "status_id": 1,
        "message": [
            "Request Successful"
        ]
    }
}

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.

{
    "surveys": [],
    "return_status": {
        "status_id": 1,
        "message": [
            "Panelist disabled for quality reasons"
        ]
    }
}

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.

{
   "surveys": [
        {
            "max_completes": 1,
            "pmr_project_type_ids": [],
            "matched_base_questions": [
                3
            ],
            "surveyurl": "https://prodegemr.prsrvydv.com/g/survey-click?projectid=32038120&sourceid=3046&vpid=9738bec7e75485814b19026399cb10fa&cpi=0.3&hsh=7402233ab943b91e5437201b94f6ad3d80298c267d36f2b23f8c9f12452814e5",
            "loi": 1,
            "inconclusive_base_questions": [],
            "project_name": "Exciting Survey 02084",
            "projectid": 32038120,
            "cpi": 0.3,
            "phases": {
                "loi_phase": "bid"
            }
        },
        {
            "max_completes": 1,
            "pmr_project_type_ids": [],
            "matched_base_questions": [
                3
            ],
            "surveyurl": "https://prodegemr.prsrvydv.com/g/survey-click?projectid=31769803&sourceid=3046&vpid=9738bec7e75485814b19026399cb10fa&cpi=1.5&hsh=5044a7917379709ead43b1f5057332f1ab8747567a6f8cb6316efe72d5568623",
            "loi": 2,
            "inconclusive_base_questions": [
                445
            ],
            "project_name": "Exciting Survey 07755",
            "projectid": 31769803,
            "cpi": 1.5,
            "phases": {
                "loi_phase": "bid"
            }
        },
        {
            "max_completes": 1,
            "pmr_project_type_ids": [],
            "matched_base_questions": [
                3
            ],
            "surveyurl": "https://prodegemr.prsrvydv.com/g/survey-click?projectid=31769684&sourceid=3046&vpid=9738bec7e75485814b19026399cb10fa&cpi=1.5&hsh=6dc80c389815ea6a307f872d84c46547ace0ab94b66df82a456aeae8982f8aa9",
            "loi": 2,
            "inconclusive_base_questions": [],
            "project_name": "Exciting Survey 02272",
            "projectid": 31769684,
            "cpi": 1.5,
            "phases": {
                "loi_phase": "actual"
            }
        }
    ],
   "return_status":{
      "status_id":1,
      "message":[
         "Panelist limited for quality reasons"
      ]
   }
}