Get Attributes By Qualification Code

GET /attributes - https://api.spectrumsurveys.com/suppliers/v2/attributes/:qualification_code?format=true&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.

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.

If your system supports the ability to route or screen respondents on the fly on qualifications for which you are missing for this respondent, this API endpoint is for you.  The goal of this endpoint is not for mapping, but rather for direct creation of question/answers within your profiling mechanism.

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

Query String Parameters

Response Parameters    

condition_codes Array

Sample API Request

GET /suppliers/v2/attributes/1031?survey_localization=en_US
Host: api.spectrumsurveys.com
access-token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Sample API Response

Example 1: Simple MultiPunch

GET /suppliers/v2/attributes/1031?survey_localization=en_US
{
  "text":"Which of the following pets do you own?",
  "cat":"Pets",
  "desc":"Pet Ownership",
  "type":3,
  "class":2,
  "condition_codes":[
	{"id":"111","text":"Dog"},
	{"id":"112","text":"Cat"},
	{"id":"113","text":"Rabbit"},
	{"id":"114","text":"Snake/Lizard"},
	{"id":"115","text":"Fish"},
	{"id":"116","text":"Small Birds"},
	{"id":"117","text":"Large Birds"},
	{"id":"118","text":"Horse/Equine"},
	{"id":"119","text":"Ferrets"},
	{"id":"120","text":"Hamster or other Rodent"},
	{"id":"121","text":"Turtle"},
	{"id":"122","text":"Exotic Pets"},
	{"id":"999","text":"None of the Above"}
  ],
  "crtd_on": 1487871678958,
  "mod_on": 1487871678958
}

Example 2: Singlepunch - in context dropdown.  This will render as The company I work for employs approximately (dropdown) people

GET /suppliers/v2/attributes/1034?survey_localization=en_US
{
  "text":"The company I work for employs approximately %1034% people",
  "cat":"B2B",
  "desc":"Company Size (Employees)",
  "type":1,
  "class":2,
  "condition_codes":[
	{"id":"111","text":"1 to 5"},
	{"id":"112","text":"6 to 9"},
	{"id":"113","text":"10 to 19"},
	{"id":"114","text":"20 to 24"},
	...
	{"id":"125","text":"50,000+"},
	{"id":"999","text":"Don't know"}
  ],
  "crtd_on": 1487871678958,
  "mod_on": 1487871678958
}

Example 3: Singlepunch - alt

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

Error Messages