Create a survey with qualifications and quotas by State
bapit-5
Create Survey
Request
POST $apihost/$basepath/surveys
($apihost is the environment against which you are testing, and $basepath is the base path with the api version. All Buy API calls will require access-token parameter in the header)
Please see here for state codes mapping: Location codes: US States to codes mapping.
This example uses CA, NY, and NJ. Their codes are 06, 36, and 34 respectively.
Parameters:
Body:
{
"survey_title": "US States Quotas - bapit-5",
"survey_category_code": 231,
"survey_localization": "en_US",
"completes_required": 1000,
"expected_ir": 60,
"expected_loi": 60,
"live_url": "https://my.survey.com?survey_id=1234",
"test_url": "https://my.survey.com?survey_id=1234&test=1",
"field_time": 10,
"qualifications": [
{
"qualification_code": 225,
"condition_codes": ["06", "36", "34"]
}
],
"quotas": [
{
"buyer_quota_id": "qb12",
"required_count": 400,
"criteria": [{"qualification_code": 225,"condition_codes": ["06"]}]
},
{
"buyer_quota_id": "qb13",
"required_count": 400,
"criteria": [{"qualification_code": 225,"condition_codes": ["36"]}]
},
{
"buyer_quota_id": "qb14",
"required_count": 200,
"criteria": [{"qualification_code": 225,"condition_codes": ["34"]}]
}
]
}
Result
Response Code
201
Response Body
{
"ps_survey_id": 7655,
"live_ps_survey_entry_link": "http://www.spectrumsurveys.com/7655",
"test_ps_survey_entry_link": "http://www.spectrumsurveys.com/7655t",
"ps_survey_status": 11,
"survey_title": "US States Quotas - bapit-5",
"survey_category_code": 231,
"survey_localization": "en_US",
"completes_required": 1000,
"ps_incidence": 60,
"length_of_interview": 60,
"live_url": "https://my.survey.com?survey_id=1234",
"test_url": "https://my.survey.com?survey_id=1234&test=1",
"field_time": 10,
"qualifications": [
{
"qualification_code": 225,//states
"conditions": [
"06", "36", "34" ]
}
],
"quotas": [
{
"buyer_quota_id": "qb12",
"required_count": 400,
"criteria": [{"qualification_code": 225,"conditions": ["06"]}]
},
{
"buyer_quota_id": "qb13",
"required_count": 400,
"criteria": [{"qualification_code": 225,"conditions": ["36"]}]
},
{
"buyer_quota_id": "qb14",
"required_count": 200,
"criteria": [{"qualification_code": 225,"conditions": ["34"]}]
},
]
}
Notes
- Supporting notes