Versions Compared

Old Version 1

changes.mady.by.user Claudio Baldi

Saved on

compared with

New Version 2

changes.mady.by.user Claudio Baldi

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 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% some % of completes have to be repeated over time

...

Info

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:

...

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

(
Status
colourRed
titleTO BE CHECKED
)

Request

...

Request (POST)

...

POST $apihost/$basepath/surveys( Status

colourRed
titleTO BE CHECKED
)

Parameters: 

Body:

...

...

colourRed
titleTO BE CHECKED

...

Code Block
languagejson
{
    "live_url": "https://yoursurvey.com/survey123",
    "test_url": "https://yoursurvey.com/survey123/test=1",
    "survey_survey_title": "Test SURVEY SurveyFEOT",
    "survey_category_code": 231,
    "survey_localization": "en_US",
    "completes_required": 31000,
    "expected_ir": 1060,
    "expected_loi": 1060,
    "offer_price": 104.5,
    "fieldlive_timeurl": 99"https://my.survey.com?survey_id=1234",
    "qualificationstest_url": ["https://my.survey.com?survey_id=1234",
    "field_time": 10,
  {        "is_feot_enabled": true,
    "qualification_codefeot": 211,
   {
        "condition_codespacing": ["hours",
        "interval": 12,
        "111is_custom",: true
    },
          "112"
"qualifications": [
        {
  ]         }
   "qualification_code": 211,
 ],     "quotas": [     "condition_codes": [
  {             "buyer_quota_id": "1111",
            "required_count": 3,   "112"
         "criteria": [  ]
        },
     {      {
              "qualification_code": 211212,
                    "condition_codes"range_sets": [
                {
       "111"             "from": 21,
      ]              "to": 59,
 }             ]      "units": 311
 },          {     }
       "buyer_quota_id": "2",    ]
        "required_count": 3,},
        {
    "criteria": [       "qualification_code": 213,
        {    "range_sets": [
               "qualification_code": 211, {
                    "condition_codesfrom": [50000,
                    "to": 100000,
  "112"                     ]"units": 321
                }
            ]
        }
    ],
    "is_feot_enabled": true,
}

Result (POST)

...

Response Code

Code Block
201

Response Body

Code Block
languagejson
{
    "qbp": {
        "
feot
enable": false
{
    },
    "
pacing
qlc":
"hours",
{
        "
interval
enable":
12
false,
        "
is
multiple_
custom
quotas":
true
{
} }

Result (
Status
colourRed
titleTO BE CHECKED
)

Response Code (
Status
colourRed
titleTO BE CHECKED
)

201 if POST, 200 if PUT

Response Body

Code Block
languagejson
{
    "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": [
        {       "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:

Code Block
languagejson
{
    "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

Code Block
200

Response Body

Code Block
languagejson
{
    "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,
                    "
condition_codes
to": 59,
[
                 "
111
from"
,
: 21
"112"
}
            ],
            "qualification_code":
211
212
        },
],
    {
"quotas":
[
{
  "range_sets": [
"buyer_quota_id": "1",
       {
"ps_quota_id":
"ba58ca72-5b4f-45d1-8bc1-6cf0e481a36b",
             "
required_count
units":
3
321,
"criteria": [
       "to": 100000,
{
"from": 50000
                }
"qualification_code":
211,
        ],
            "
condition
qualification_
codes
code":
[
213
        }
    ],
    "is_feot_enabled": true,
    "
111
feot": {
        "is_custom": true,
]
"pacing": "hours",
        "interval": 10
    },
}
"survey_grouping": [],
    "blend_id": null,
    "schedule_launch": {
]
        "enable":
}
false,
        "info": {
            "
buyer_quota_id
date":
"2"
null,
            "
ps_quota_id
hours":
"f34610da-da3c-426c-9929-bc8e287f659f"
null,
            "
required_count
minutes":
3
null,
            "
criteria
timezone": null,
[
            "dateTimeInISO": null
{
     }
    },
    "price_reco": false,
    "
qualification
project_creation_
code
date":
211
"2024-02-07T10:21:57.453Z",
    "project_last_complete_date": null,
    "is_dq_enable": false,
    "mc_count": 0,
    "
condition
tc_
codes
count":
[
0,
    "basic_token": {
        "enable": false,
        "
112
value": null
    },
    "is_pure_price_rate_card_enable": true,
] 
"dq_settings": {
        "purescore_filter_enabled": true,
}
    "fp_device_check": true,
] 
 "fp_fraud_check": true
    },
}
] }

Error Handling

...

Status
colourRed
titleTO BE CHECKED

...

"product": ""
}