...
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 change |
Implementation
For trusted enterprise buyers that choose to integrate into the PureSpectrum Buy API - we offer the ability to create custom targeting attributes, based on your targeting library. Before creating survey, qualification, or quota that will require custom targeting, your integration should call this API to create a new qualification within the PureSpectrum library. We will return a qualification id that corresponds to your new attribute, as well as condition id's that correspond to you answer id's. Once you map these values internally, you may then create a survey with these new targets!
...
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) | |
tags | string | Comma separated list of tags that are searchable via Question Library UI | if no tags are present, api will returned “tags”:undefined |
localizations | enum | Contains the question text and their respective answer text and ID's | |
localization | string | Lists the type of language code the answer needs to be in | |
respID | string | This needs to be included in the text and acts as a container for answers block | |
answers | array | Its acts a container for range of "buyer_answer_id's" and corresponding "answer_text's" | |
buyer_answer_id | string | It is the "answer_id" to the question raised by buyer | |
answer_test | string | It is the "answer_text" to the question raised by buyer | |
condition_codes | array | Contains the condition codes and condition code texts |
...
Code Block |
---|
POST /buyers/v1/attributes/ Host: api.spectrumsurveys.com access-token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx { "buyer_attribute_id":"ABC123", "desc":"Pet Food Preferences", "category":"Pets", "type":1, //singlepunch "tags":"tag1,tag2", "localizations":[ { "localization" : "en_US", "text": "Do you purchase dry or wet Dog Food?%%respID%%" "answers":[ { "buyer_answer_id" : "DEF456-1", "text" : "Dry Food" }, { "buyer_answer_id" : "DEF456-2", "text" : "Wet Food" }, { "buyer_answer_id" : "DEF456-99", "text" : "Not Sure/Doesn't Apply" } ] }, { "localization" : "en_CA", "text": "Do you purchase dry or wet Dog Food?%%respID%%" "answers":[ { "buyer_answer_id" : "DEF456-1", "text" : "Dry Food" }, { "buyer_answer_id" : "DEF456-2", "text" : "Wet Food" }, { "buyer_answer_id" : "DEF456-99", "text" : "Not Sure/Doesn't Apply" } ] } } |
...
Code Block |
---|
{
"ps_qualification_code" : 1110
"buyer_attribute_id" : "ABC123",
"desc" : "Pet Food Preferences",
"Category" : "Pets",
"type":1,
"tags":"tag1,tag2",
"localizations":[
{
"localization" : "en_US",
"text": "Do you purchase dry or wet Dog Food?%%respID%%"
"answers":[
{
"buyer_answer_id" : "DEF456-1",
"ps_cond_code":"111"
"text" : "Dry Food"
},
{
"buyer_answer_id" : "DEF456-2",
"ps_cond_code":"112"
"text" : "Wet Food"
},
{
"buyer_answer_id" : "DEF456-99",
"ps_cond_code":"113"
"text" : "Not Sure/Doesn't Apply"
}
]
},
{
"localization" : "en_CA",
"text": "Do you purchase dry or wet Dog Food?%%respID%%"
"answers":[
{
"buyer_answer_id" : "DEF456-1",
"ps_cond_code":"111"
"text" : "Dry Food"
},
{
"buyer_answer_id" : "DEF456-2",
"ps_cond_code":"112"
"text" : "Wet Food"
},
{
"buyer_answer_id" : "DEF456-99",
"ps_cond_code":"113"
"text" : "Not Sure/Doesn't Apply"
}
]
}
]
}
|
...