Setting Up a Survey to Count Quotas on Clicks Instead of Completes (Click Balancing)
In some cases, you may desire to set up a survey where quotas are counted on Valid Clicks instead of completes.
This can be accomplished using the request parameter click_balancing:1.
If click_balancing:1 is set, the required_count for the quotas will reflect clicks required instead of completes required.
In the API request, “completes_required” still refers to the number of completes you are looking for
Once a survey is launched, you may not change the value of “click_balancing”
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)
Parameters:
Body:
{
"survey_title": "Automobile Preferences bapit-1",
"survey_category_code": 231,
"survey_localization": "en_US",
"completes_required": 300,
"offer_price": 3.25,
"expected_ir": 50,
"expected_loi": 10,
"live_url": "https://my.survey.com?survey_id=1234",
"test_url": "https://my.survey.com?survey_id=1234&test=1",
"field_time": 10,
"click_balancing":1,
"qualification":[{
"qualification_code": 211,
"condition_codes": ["111", "112"]
}],
"quotas":[{
"buyer_quota_id": "qb12",
"required_count": 300,
"criteria": [{"qualification_code": 211,"condition_codes": ["111"]}]
},
{
"buyer_quota_id": "qb13",
"required_count": 300,
"criteria": [{"qualification_code": 211,"condition_codes": ["112"]}]
}]
}
Result
The request above will create a draft survey, looking for 300 completes, at 50%IR, or an estimated total 600 valid clicks.
There is a quota for Males, with 300 clicks, and a quota for Females with 300 clicks.
Response Code
201
Response Body
{
"click_balancing": 1,
"estimated_clicks": 600,
"ps_survey_status": 11,
"offer_price": 3.25,
"incl_excl": 0,
"live_url": "https://my.survey.com?survey_id=1234",
"test_url": "https://my.survey.com?survey_id=1234&test=1",
"survey_title": "Automobile Preferences bapit-1",
"survey_category_code": 231,
"completes_required": 300,
"field_time": 10,
"billing_id": null,
"buyer_message": null,
"expected_loi": 10,
"expected_ir": 50,
"ps_survey_id": 144867,
"buyer_surveygroup_ref": null,
"test_ps_survey_entry_link": "https://spectrumsurveys.com/startsurvey?survey_id=144867&ps_redirect_test=1&bsec=a70mx8&supplier_id=23",
"survey_localization": "en_US",
"uniqueLinks": false,
"qualifications": [
{
"condition_codes": [
"111",
"112"
],
"qualification_code": 211
}
],
"quotas": [
{
"buyer_quota_id": "qb12",
"ps_quota_id": "aa6e0bc6-9d77-4da6-97d6-ca8d473f5823",
"required_count": 300,
"criteria": [
{
"qualification_code": 211,
"condition_codes": [
"111"
]
}
]
},
{
"buyer_quota_id": "qb13",
"ps_quota_id": "3862f177-143c-4e43-9478-d77c0fab3d4b",
"required_count": 300,
"criteria": [
{
"qualification_code": 211,
"condition_codes": [
"112"
]
}
]
}
]
}