Survey Eligibility Check

Optional API for checking panelist eligibility for a single survey.

Get Eligibility Status

Check if a panelist is eligible for a specific survey based on survey status, qualifications, and past participation requirements.

Request URL	/get-survey-eligibility-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
ip	String	Yes	User’s IP (IPv4 Only)
useragent	String	Yes	User’s useragent
vpid	String	Yes	The supplier’s static panelist ID
project_id	Numeric	Yes	The project ID of the survey you want to check.

Response Parameters

Parameter Name	Parameter Type	Description / Notes
return_status	Array	The return status for this api call
result	String	Either Eligible or Not eligible.

Response Parameters

{
   "result":"Eligible",
   "return_status":{
      "status_id":1,
      "message":[
         "Request Successful"
      ]
   }
}