...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
GET /attributes - http://api.spectrumsurveys.com/suppliers/v2/attributes/:qualification_code?localization=:localization
...
Call this API to view the respondent's question text, condition codes, and condition code texts for unfamiliar qualification codes/condition codes. Survey_localization is a required Query String parameter.
| Warning |
|---|
Not yet available, api specs subject to changeNow available on Production - known issues: mod_on & crtd_on return `null` |
Implementation
As the PureSpectrum platform continues to expand its Respondent targeting library, it is important that you are able to import foreign targeting attributes & profile your respondents before sending them into a survey. Your ability to do so will greatly improve conversion, reduce time to termination, and provide you with better population data about your supply.
...
When importing a new survey, qualification, or quota into your survey inventory via API - take into consideration if any of the qualifications or the qualification's condition codes are unknown within your system. If so, fail the survey import and call the GET /attributes endpoint with the qualification and survey localization. Parse the response and create this new qualification within your system.
Considerations
- Qualifications are shared across surveyLocalizations on PureSpectrum. For example, we use the same code for b2b employment in the US/English, that we use in Japanese Japan.
- Condition codes when appropriate are also shared across localizations
- Even though the codes may be the same, we represent these questions/answers using the appropriate language/localization
- We only currently support 3 question types in this api call: Singlepunch, Singlepunch-alt, & Multipunch
- singlepunch is presented as a dropdown. Singlepunch-alt and Multipunch are shown in push-button form
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 |
|---|---|---|---|
localization | string | Yes | Define the Country & Language combination for which you need the attribute's question/answer text returned |
Response Parameters
Parameter | Type | Description | Nullable |
|---|---|---|---|
text | string | The text of the question asked to the respondent | |
| desc | string | A description of the question that is asked of the respondent | |
| cat | string | Category name of the question that is asked of the respondent | |
type | integer | 1=singlepunch (only one selection is allowed, presented in dropdown form) 2=singlepunch-alt (only one selection is allowed - presented in push button form) 3=multipunch (multiple selections are allowed, presented in push button form) 4=range (not currently supported) | |
| class | integer | 1 = Core profiling question 2 = Extended profiling question 3 = Custom profiling question | |
| condition_codes | array | contains the condition codes and condition code texts | |
| crtd_on | UTC Timestamp in milliseconds since Unix Epoch | Timestamp of when this attribute was created | |
| mod_on | UTC Timestamp in milliseconds since Unix Epoch | Timestamp of when this attribute was modified. This may include a change in text, addition or modification of condition codes. In case the mod_on has changed since your last sync, delete the qualification in your system and recreate it to prevent inconsistencies. |
condition_codes Array
| Parameter | Type | Description | Nullable |
|---|---|---|---|
| id | string | the condition code of the corresponding text. This will match the requisite condition codes in a survey's qualifications/quotas | |
| text | string | The text of the answer presented to the respondent |
Sample API Request
| Code Block |
|---|
GET /suppliers/v2/attributes/1031?survey_localization=en_US Host: api.spectrumsurveys.com access-token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
Sample API Response
Example 1: Simple MultiPunch
...
| Code Block |
|---|
GET /suppliers/v2/attributes/1040?survey_localization=en_US
{
"text":"Are you registered in any of the following US political parties?",
"cat":"Politics",
"desc":"Political Party Affiliation",
"type":1,
"class":2,
"condition_codes":[
{"id":"111","text":"Democratic Party"},
{"id":"112","text":"Republican Party"},
{"id":"113","text":"Independent"},
{"id":"114","text":"Constitution Party"},
...
{"id":"117","text":"Other"},
{"id":"118","text":"I am not registered with a political party"}
],
"crtd_on": 1487871678958,
"mod_on": 1487871678958
} |
HTTP Response Codes
Response | Status | Description |
|---|---|---|
200 | OK | |
| 400 | Bad Request | See Error Messages |
| 404 | Not Found | Qualification code doesn't exist in database |
5xx | Internal Server Error | Please Report to support@purespectrum.com |
Error Messages
Response | Description |
|---|---|
1001 | Missing localization parameter |
| 1002 | Qualification doesn't exist in localization code |
9999 | Unknown Error - Please Report to support@purespectrum.com |
...