| Code Block |
|---|
Get Surveys - GET /attributes - https://api.spectrumsurveys.com/suppliers/v2/attributes?format=true&localization=:localization&mod_on_start=:YYYYMMDD&class=:class |
...
Call this API to view all qualifications that were created or modified since a specified date. Survey_localization is a required Query String parameter. mod_on_start & class are optional parameters. Data is paginated if there are more than 50 items.
| Warning |
|---|
| Note |
You should only use the response from the production environment when using this API to map. Qualifications in staging may be different than production. |
| Note |
|---|
Make sure that you are including the 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, you should use the endpoint Get Attributes By Qualification Code. If you would prefer to periodically import new/updated profiling targets, then it would make more sense to use this one.
...
.
...
You may also consider using this to download a list of questions by class that you can use to map, for example questions in class=1(Core) or class=2(Extended)
...
Parameter | Required | Description |
|---|---|---|
localization | Yes | Define the Country & Language combination for which you need the attribute's question/answer text returned |
class | No | Will return targeting attributes that correspond to the defined class. 1=core, 2=extended, 3=custom. It won't make much sense to use class=3. |
mod_on_start | No | Will return attributes that have been created or modified after the specified date. Very useful if running a nightly cron to check for updates |
page | No | Required in case of pagination. The endpoint will return a max of 25 entries per page |
format | Yes | Boolean field, set to true. This flag was previously used for compatibility, failure to include will exclude qualifications. |
Response Header Parameters
...
| Code Block |
|---|
GET /suppliers/v2/attributes?survey_localization=en_US&mod_on_start=20170729&page=3&class=2&format=true
Host: api.spectrumsurveys.com
access-token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
...
| Code Block |
|---|
GET /suppliers/v2/attributes/1031?survey_localization=en_US&format=true
{
"apiStatus": "success",
"msg": "Attributes fetched successfully for Qualification code",
"version": "2.0",
"qual_attributes": [
{
"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
}
]
} |
...
| Code Block |
|---|
GET /suppliers/v2/attributes/1034?survey_localization=en_US&format=true
{
"apiStatus": "success",
"msg": "Attributes fetched successfully for Qualification code",
"version": "2.0",
"qual_attributes": [
{
"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
}
]
} |
...
| Code Block |
|---|
GET /suppliers/v2/attributes/1040?survey_localization=en_US&format=true
{
"apiStatus": "success",
"msg": "Attributes fetched successfully for Qualification code",
"version": "2.0",
"qual_attributes": [
{
"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
}
]
} |
...