The primary use of this API endpoint is to check the PSID eligibility across multiple surveys. The checks included are eligibility checks for some external buyers,
URL
POST/suppliers/v2/surveys/PSIDEligible/batch?PSID=%PSID%&rd_device_id=[%%research_defender_respondent_ud%%]&ip_address=[%%ipv4_address%%]
HEADER Parameters
Parameter | Type | Required | Description |
---|---|---|---|
access-token | string | Yes | Token used to identify the authenticity of the user. |
QUERY STRING PARAMETERS
Parameter | Type | Required | Description |
---|---|---|---|
PSID | string | Yes | The respondent's persistent PSID |
rd_device_id | string | No | Will check a respondent using Research Defender's /predupe api. Use this to reduce |
ip_address | string | No | Will check a respondent's eligibility with some buyers. IP Address should be in the format |
The API is case sensitive
BODY
{ "surveys": [866370,838376,814083,805719,866359,908942,880009]}
Sample Response
{ "apiStatus": "success", "msg": "PSID Eligibility Checked successfully", "version": "2.0", "eligible": [ {"surveyId": 866370}, {"surveyId": 838376}, {"surveyId": 805719}, {"surveyId": 866359}, {"surveyId": 908942} ], "ineligible": [ {"surveyId": 814083}, {"surveyId": 111111111}, {"surveyId": 880009} }
HTTP Response Codes
Response | Status | Description |
---|---|---|
200 | OK | |
400 | Bad Request | See Error Messages |
401 | Unauthorized | Check Access Token |
5xx | Internal Server Error | Please Report to support@purespectrum.com |
Error Messages
Response | Description |
---|---|
9999 | Unknown Error - Please Report to support@purespectrum.com |