The primary use of this API endpoint is to check the PSID eligibility across multiple surveys. The eligibility checks span across several areas of our system, including but not limited to survey grouping, deduplication, Research Defender, include/exclude rules, and some external buyer checks.
URL
| Code Block | ||
|---|---|---|
| ||
POST/suppliers/ |
...
v2/surveys/PSIDEligible/batch?PSID=[%PSID%]&rd_device_id=[%%research_defender_respondent_ud%%]&ip_address=[%%ipv4_address%%] |
The primary use of this API End Point is to check the PSID exclusion across multiple surveys.
METHOD
| Code Block |
|---|
POST |
URL
...
| language | none |
|---|
...
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 |
|---|---|---|---|
PSIDpsid | string | Yes | The respondent's persistent PSID |
rd_device_id | string | YesNo | Will check a respondent using Research Defender's /predupe api. Use this to reduce |
ip_address | string | YesNo | Will check a respondent's eligibility with some buyers. IP Address should be in the format |
...
| Code Block |
|---|
{ "surveys": [866370, 838376, 814083, 805719, 866359, 908942, 804404,866402, 111111111, 880009]} |
...
Sample Response
| Code Block |
|---|
{ "apiStatus": "success",
"msg": "PSID Eligibility Checked successfully",
"version": "2.0",
"eligible": [ { "surveyId": 866370},
{ "surveyId": 838376},
{"surveyId": 805719},
{ "surveyId": 866359},
{ "surveyId": 908942}
],
"ineligible": [ { "surveyId": 814083, "reason": "PSIDRef ineligible" },
{ "surveyId": 111111111, "reason": "Survey ID Not Found" },
{ "surveyId": 880009, "reason": "PSIDRef ineligible" }
} |
...
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 |
Considerations
Please note that the PSID is not validated in the request, it is simply checked as a value within our exclusion rules. So if you pass in an invalid PSID in the request, it will return the ID as eligible to take all valid surveys that are available at that time.