Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Current »

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

  • 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.

This the error message in case the feature is not activated:

{"status":"Failure","msg":"This users dosen't have access to this feature"}

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:

  • hours

  • days

  • weeks (7 days from launch date)

with "is_custom": true.

In case you use "is_custom": false, the pacing used will be days

Important Considerations

  • The pacing cannot be bigger that field_time

  • Make sure to create a script that check the field_time is bigger than the pacing/interval

Request (POST)

POST $apihost/$basepath/surveys

Parameters: 

Body:

{
    "survey_title": "Test SURVEY FEOT",
    "survey_category_code": 231,
    "survey_localization": "en_US",
    "completes_required": 1000,
    "expected_ir": 60,
    "expected_loi": 60,
    "offer_price": 4.5,
    "live_url": "https://my.survey.com?survey_id=1234",
    "test_url": "https://my.survey.com?survey_id=1234",
    "field_time": 10,
    "is_feot_enabled": true,
    "feot": {
        "pacing": "hours",
        "interval": 12,
        "is_custom": true
    },
    "qualifications": [
        {
            "qualification_code": 211,
            "condition_codes": [
                "111",
                "112"
            ]
        },
        {
            "qualification_code": 212,
            "range_sets": [
                {
                    "from": 21,
                    "to": 59,
                    "units": 311
                }
            ]
        },
        {
            "qualification_code": 213,
            "range_sets": [
                {
                    "from": 50000,
                    "to": 100000,
                    "units": 321
                }
            ]
        }
    ]
}

Result (POST)

Response Code 

201

Response Body

{
    "qbp": {
        "enable": false
    },
    "qlc": {
        "enable": false,
        "multiple_quotas": {
            "enable": false,
            "count_by_quota": false,
            "compensate_by_quota": false
        }
    },
    "soft_launch": {
        "enable": false
    },
    "unique_links": {
        "enable": false
    },
    "click_balancing": 0,
    "estimated_clicks": 0,
    "survey_external_id": "",
    "ps_survey_status": 11,
    "offer_price": 4.5,
    "incl_excl": 0,
    "quota_throttling": false,
    "url_transform": false,
    "subscriber_emails": [],
    "survey_title": "Test SURVEY FEOT",
    "survey_category_code": 231,
    "completes_required": 1000,
    "field_time": 10,
    "buyer_message": null,
    "live_url": "https://my.survey.com?survey_id=1234",
    "billing_id": "MM35487305",
    "test_url": "https://my.survey.com?survey_id=1234",
    "expected_loi": 60,
    "expected_ir": 60,
    "ps_survey_id": 23231665,
    "buyer_surveygroup_ref": null,
    "buyer_surveygroup_refs": [],
    "test_ps_survey_entry_link": "https://spectrumsurveys.com/#/start-survey?survey_id=23231665&ps_redirect_test=1&bsec=a70mx8&supplier_id=23",
    "survey_localization": "en_US",
    "uniqueLinks": false,
    "quotas": [],
    "qualifications": [
        {
            "condition_codes": [
                "111",
                "112"
            ],
            "qualification_code": 211
        },
        {
            "range_sets": [
                {
                    "units": 311,
                    "to": 59,
                    "from": 21
                }
            ],
            "qualification_code": 212
        },
        {
            "range_sets": [
                {
                    "units": 321,
                    "to": 100000,
                    "from": 50000
                }
            ],
            "qualification_code": 213
        }
    ],
    "is_feot_enabled": true,
    "feot": {
        "is_custom": true,
        "pacing": "hours",
        "interval": 12
    },
    "survey_grouping": [],
    "blend_id": null,
    "schedule_launch": {
        "enable": false,
        "info": {
            "date": null,
            "hours": null,
            "minutes": null,
            "timezone": null,
            "dateTimeInISO": null
        }
    },
    "price_reco": false,
    "project_creation_date": "2024-02-07T10:21:57.453Z",
    "project_last_complete_date": null,
    "is_dq_enable": false,
    "mc_count": 0,
    "tc_count": 0,
    "basic_token": {
        "enable": false,
        "value": null
    },
    "is_pure_price_rate_card_enable": true,
    "dq_settings": {
        "purescore_filter_enabled": true,
        "fp_device_check": true,
        "fp_fraud_check": true
    },
    "product": ""
}

Request (PUT)

POST $apihost/$basepath/surveys/#surveyid

Parameters: 

Body:

{
    "survey_title": "Test SURVEY FEOT",
    "survey_category_code": 231,
    "survey_localization": "en_US",
    "completes_required": 1000,
    "expected_ir": 60,
    "expected_loi": 60,
    "offer_price": 4.5,
    "live_url": "https://my.survey.com?survey_id=1234",
    "test_url": "https://my.survey.com?survey_id=1234",
    "field_time": 10,
    "is_feot_enabled": true,
    "feot": {
        "pacing": "hours",
        "interval": 10,
        "is_custom": true
    },
    "qualifications": [
        {
            "qualification_code": 211,
            "condition_codes": [
                "111",
                "112"
            ]
        },
        {
            "qualification_code": 212,
            "range_sets": [
                {
                    "from": 21,
                    "to": 59,
                    "units": 311
                }
            ]
        },
        {
            "qualification_code": 213,
            "range_sets": [
                {
                    "from": 50000,
                    "to": 100000,
                    "units": 321
                }
            ]
        }
    ]
}

Result (PUT)

Response Code 

200

Response Body

{
    "qbp": {
        "enable": false
    },
    "qlc": {
        "enable": false,
        "multiple_quotas": {
            "enable": false,
            "count_by_quota": false,
            "compensate_by_quota": false
        }
    },
    "soft_launch": {
        "enable": false
    },
    "unique_links": {
        "enable": false
    },
    "click_balancing": 0,
    "estimated_clicks": 0,
    "survey_external_id": "",
    "ps_survey_status": 11,
    "offer_price": 4.5,
    "incl_excl": 0,
    "quota_throttling": false,
    "url_transform": false,
    "subscriber_emails": [],
    "survey_title": "Test SURVEY FEOT",
    "survey_category_code": 231,
    "completes_required": 1000,
    "field_time": 10,
    "buyer_message": null,
    "live_url": "https://my.survey.com?survey_id=1234",
    "billing_id": "MM35487305",
    "test_url": "https://my.survey.com?survey_id=1234",
    "expected_loi": 60,
    "expected_ir": 60,
    "ps_survey_id": 23231665,
    "buyer_surveygroup_ref": null,
    "buyer_surveygroup_refs": [],
    "test_ps_survey_entry_link": "https://spectrumsurveys.com/#/start-survey?survey_id=23231665&ps_redirect_test=1&bsec=a70mx8&supplier_id=23",
    "survey_localization": "en_US",
    "uniqueLinks": false,
    "quotas": [],
    "qualifications": [
        {
            "condition_codes": [
                "111",
                "112"
            ],
            "qualification_code": 211
        },
        {
            "range_sets": [
                {
                    "units": 311,
                    "to": 59,
                    "from": 21
                }
            ],
            "qualification_code": 212
        },
        {
            "range_sets": [
                {
                    "units": 321,
                    "to": 100000,
                    "from": 50000
                }
            ],
            "qualification_code": 213
        }
    ],
    "is_feot_enabled": true,
    "feot": {
        "is_custom": true,
        "pacing": "hours",
        "interval": 10
    },
    "survey_grouping": [],
    "blend_id": null,
    "schedule_launch": {
        "enable": false,
        "info": {
            "date": null,
            "hours": null,
            "minutes": null,
            "timezone": null,
            "dateTimeInISO": null
        }
    },
    "price_reco": false,
    "project_creation_date": "2024-02-07T10:21:57.453Z",
    "project_last_complete_date": null,
    "is_dq_enable": false,
    "mc_count": 0,
    "tc_count": 0,
    "basic_token": {
        "enable": false,
        "value": null
    },
    "is_pure_price_rate_card_enable": true,
    "dq_settings": {
        "purescore_filter_enabled": true,
        "fp_device_check": true,
        "fp_fraud_check": true
    },
    "product": ""
}
  • No labels