Create survey

Description

The Create Survey endpoint is a fundamental component of the PureSpectrum Buy API, enabling clients to programmatically define and launch surveys with specific qualifications and completion requirements.

Key aspects of the Create Survey endpoint include:

Initiating Surveys: It is the primary method for programmatically setting up new surveys within the PureSpectrum marketplace

Configuration via Parameters: The endpoint accepts a variety of parameters in the request body to define the survey's characteristics.

Setting up Qualifications and Quotas: The endpoint allows for the inclusion of qualification criteria and quotas at survey creation, enabling precise targeting of respondents.

For a soft launch, the sum of the required counts of all quotas can be set below the total number of completes (survey goal).

For quota flexibility, the sum of the required counts of all quotas can be set above the survey goal.

The survey will automatically be set to Pause status once each of the quotas or survey goal is achieved.

Integration with Other Features: The Create Survey endpoint interacts with other Buy API features, such as the ability to set up click balancing, create recontact surveys, etc.

The detailed request and response parameters for this endpoint are further outlined in the examples included in the Create Survey Examples guide.

Request

Authorization

Add parameter in header

access-token

Example:

access-token: ********************

Body Params application/json

Examples

Without qualifications or quotasWith qualifications and quotas

{
    "survey_title": "Test New Survey",
    "survey_category_code": 211,
    "survey_localization": "en_US",
    "completes_required": 300,
    "expected_ir": 60,
    "expected_loi": 10,
    "live_url": "https://my.survey.com?survey_id=123456",
    "test_url": "https://my.survey.com?survey_id=123456&amp;test=1",
    "field_time": 10
}

Request Code Samples

Shell

JavaScript

Java

PHP

Python

Ruby

Responses

🟢201Created

application/json

Create survey response JSON data.

Body

Example

{
    "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": 3.25,
    "incl_excl": 0,
    "quota_throttling": false,
    "url_transform": false,
    "subscriber_emails": [],
    "survey_title": "Test New Survey",
    "survey_category_code": 231,
    "completes_required": 300,
    "field_time": 10,
    "buyer_message": null,
    "is_modular_survey": false,
    "live_url": "https://my.survey.com?survey_id=1234",
    "billing_id": "PS1118404",
    "test_url": "https://my.survey.com?survey_id=1234&amp;test=1",
    "expected_loi": 10,
    "expected_ir": 60,
    "ps_survey_id": 1118404,
    "buyer_surveygroup_ref": null,
    "buyer_surveygroup_refs": [],
    "test_ps_survey_entry_link": "https://staging.spectrumsurveys.com/#/start-survey?survey_id=1118404&ps_redirect_test=1&bsec=a70mx8&supplier_id=23",
    "survey_localization": "en_US",
    "uniqueLinks": false,
    "quotas": [],
    "qualifications": [],
    "is_feot_enabled": false,
    "feot": {},
    "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": "2025-03-07T20:51:43.426Z",
    "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": "",
    "pds_ignore_override": false,
    "supplier_allocation_throttle": true,
    "blend_applied": false
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Description#

Request

Request Code Samples

Responses

Description