...
...
GET /Surveys/:Survey_id/PSIDRef - http://api.spectrumsurveys.com/suppliers/v2/Surveys/:Survey_id/PSIDRef
PureSpectrum offers its buyers the ability to recontact respondents using their persistent PureSpectrum Id (PSID). The same mechanism is also used by suppliers to understand which respondents to exclude due to deduplication.
Implementation
Every survey on PureSpectrum will have a "PSIDRef" List. Whether this list is used for Include or Exclude is determined by the response parameter "Incl_excl" present in the GET /Surveys
or GET /Surveys/:Survey_id call. The value of Include Exclude will not change for a survey which goes live.
"incl_excl":0 indicates PSIDRef is an exclude list
...
PSIDRef returns an array of PSID's, which are persistent respondent id's. You may use this list in conjunction with the value of `incl_excl` present in the GET /surveys & GET /surveys/:survey_id calls.
| Info |
|---|
If the value of "incl_excl" is 1, then the survey is an "include" survey. The PSIDRef returns the list of respondents that are eligible to take the survey and is updated in real time. If the value of "incl_excl" is 0, then PSIDRef will list the respondents which are no longer eligible to take the survey due to deduplication or other reasons. By default, surveys on PureSpectrum are "incl_excl":0. |
API Response for GET /surveys/:survey_id/PSIDRef
{ "PSIDRef":[ "75xxee23-370b-a8ye-e601-e1fzz59284c8" "94xx7b3b-4608-01y4-b908-8aezzab971e1" "24xx7db6-8507-47y9-9c67-0c6zz6244d98" ]} |
Include
Include Survey's are sometimes referred to as recontact surveys. Effectively a buyer will define the list of respondents which they are attempting to reach. When a respondent that is on this list completes the survey, their id will automatically be removed from the PSIDRef list. As long as the PSID is present on the Ref list, the respondent may take the survey. PSID's are consistent across suppliers, so it is possible that the respondent may take a survey from one supplier, and be recontacted via a different supplier.
As a supplier, you should be storing the PSID of each respondent you send into PureSpectrum. We always append the PSID of the respondent on redirect back to you.
PSID is loosely based on device id. While unlikely, it is possible that the PSID of a respondent may change. You should always overwrite the PSID of your respondents in case the PSID changes.
If you see that a survey has "incl_excl":1, your system should call the api endpoint GET /surveys/:survey_id/PSIDRef. If any of the PSID's match within your system, you may then target these respondents for this survey.
Exclude
If a survey is not defined as an include survey, the PSIDref list will always contain the EXCLUDE list. This is the default for surveys created on PureSpectrum. Leveraging the exclude list will allow you the ability to avoid termination due to deduplication. You may either call the survey's PSIDRef list, and store it, or you may use the optional query string parameter /PSIDref?PSID=%respondent'sPSID%
...
API Response for "GET /surveys/:survey_id/PSIDEligible?PSID=75xxee23-370b-a8ye-e601-e1fzz59284c8"
{ "eligible":1 // 1 is eligible, 0 is ineligible. } |
. Documentation available here: GET PSIDEligible
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
Response Parameters
Parameter | Type | Description | Nullable |
|---|
...
text
...
string
...
| PSIDRef | array of strings | Contains a list of |
...
PSID's. These id's used in conjunction with value of "incl_excl" will give you instruction on which respondents are eligible to take this specific survey. | No |
HTTP Response Codes
Response | Status | Description |
|---|---|---|
200 | OK | |
| 400 | Bad Request | See Error Messages |
| 401 | Unauthorized | Check Access Token |
| 404 | Not Found |
...
| Invalid Survey ID | ||
5xx | Internal Server Error | Please Report to support@purespectrum.com |
Error Messages
Response | Description |
|---|---|
1001 | Invalid Survey ID |
...
9999 | Unknown Error - Please Report to support@purespectrum.com |