Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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, 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
languagenone
POST/suppliers/v2/surveys/PSIDEligible/batch?PSID=[%PSID%]&rd_device_id=[%%research_defender_respondent_ud%%]&ip_address=[%%ipv4_address%%]

...

Parameter

Type

Required

Description

PSIDpsid

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 ps_df_dupe statuses

ip_address

string

No

Will check a respondent's eligibility with some buyers.  IP Address should be in the format 0.0.0.0

...

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.