Overview
Buyers have use cases that require them to collect an even number of completes over a period of time,
to ensure representativeness of sample
have an even number of completes over a period of time
recontact a fixed number of respondents per day
have demographic spread across various concept evaluations in the survey
conduct dipstick research whereby some% of completes have to be repeated over time
FEOT takes the desired number of completes and divides them evenly over the defined number of weeks, days and hours. For example, if we want 10 completes evenly spaced over 5 days: FEOT will allow a max of 2 completes per day for 5 days.
NOTE: In order to use this functionality, the feature should be activated to you account. If you need to activate, please contact your account manager.
Use FEOT BuyAPI
To enable FEOT on a survey via Buy API, you must pass in the following request body parameters in either the POST /surveys or PUT /surveys/:surveyId endpoints:
"is_feot_enabled": true,
"feot": {
"pacing": "hours",
"interval": 12,
"is_custom": true
}
Use the one of these values to change the pacing:
hoursdaysweeks
with "is_custom": true.
In case you use "is_custom": false, the pacing used will be days
Important Considerations
(TO BE CHECKED)
Request
POST (or PUT) $apihost/$basepath/surveys (TO BE CHECKED)
Parameters:
Body: (TO BE CHECKED)
{
"live_url": "https://yoursurvey.com/survey123",
"test_url": "https://yoursurvey.com/survey123/test=1",
"survey_title": "Test Survey",
"survey_category_code": 231,
"survey_localization": "en_US",
"completes_required": 3,
"expected_ir": 10,
"expected_loi": 10,
"offer_price": 10,
"field_time": 99,
"qualifications": [
{
"qualification_code": 211,
"condition_codes": [
"111",
"112"
]
}
],
"quotas": [
{
"buyer_quota_id": "1",
"required_count": 3,
"criteria": [
{
"qualification_code": 211,
"condition_codes": [
"111"
]
}
]
},
{
"buyer_quota_id": "2",
"required_count": 3,
"criteria": [
{
"qualification_code": 211,
"condition_codes": [
"112"
]
}
]
}
],
"is_feot_enabled": true,
"feot": {
"pacing": "hours",
"interval": 12,
"is_custom": true
}
}
|
Result (TO BE CHECKED)
Response Code (TO BE CHECKED)
201 if POST, 200 if PUT
Response Body
{
"click_balancing": 0,
"estimated_clicks": 0,
"ps_survey_status": 11,
"offer_price": 10,
"incl_excl": 0,
"live_url": "https://yoursurvey.com/survey123",
"test_url": "https://yoursurvey.com/survey123/test=1",
"survey_title": "Test Survey",
"survey_category_code": 231,
"completes_required": 3,
"field_time": 99,
"billing_id": null,
"buyer_message": null,
"expected_loi": 10,
"expected_ir": 10,
"ps_survey_id": 68463,
"buyer_surveygroup_ref": null,
"subscriber_emails": [],
"is_feot_enabled": true,
"feot": {
"pacing": "hours",
"interval": 12,
"is_custom": true
},
"quota_throttling": false,
"test_ps_survey_entry_link": "https://staging.spectrumsurveys.com/startsurvey?survey_id=68463&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": "1",
"ps_quota_id": "ba58ca72-5b4f-45d1-8bc1-6cf0e481a36b",
"required_count": 3,
"criteria": [
{
"qualification_code": 211,
"condition_codes": [
"111"
]
}
]
},
{
"buyer_quota_id": "2",
"ps_quota_id": "f34610da-da3c-426c-9929-bc8e287f659f",
"required_count": 3,
"criteria": [
{
"qualification_code": 211,
"condition_codes": [
"112"
]
}
]
}
]
}
|
Error Handling
(TO BE CHECKED)
Add Comment