Multiple Survey Eligibility Check

Option API for checking panelist eligibility for multiple surveys at a time.

Get Eligibility Status

Check if a panelist is eligible for up to 100 surveys at a time based on survey status, qualifications, and past participation requirements.

Request URL

/get-multi-project-eligibility

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

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

multi_project_ids

Numeric

Yes

The project IDs of the surveys you want to check.

Response Parameters

Parameter Name

Parameter Type

Description / Notes

return_status

Array

The return status for this api call

invalid_project_ids

Array

Array of project IDs passed in the request that are not valid (e.g. do not exist).

eligible_project_ids

Array

Array of project IDs passed in the request that are eligible for the user.

not_eligible_project_ids

Array

Array of project IDs passed in the request that are NOT eligible for the user.

Example Response

{
   "invalid_project_ids":[
      53367
   ],
   "eligible_project_ids":[
      41451781,
      41385241
   ],
   "not_eligible_project_ids":[
      41465001
   ],
   "return_status":{
      "status_id":1,
      "message":[
         "Request Successful"
      ]
   }
}

Last updated