We hope you enjoy our updated documentation! The old documentation website is still available here. Reach out to us with feedback or questions. Happy programming! 🎉

Feasibility & Pricing

POST

/feasibility

Last modified:2025-07-19 21:21:31

Description

This endpoint gives you an estimated feasibility and the recommended CPI without actually creating a survey on PureSpectrum platform.

This endpoint is meant to be used as an estimator for the feasibility and CPI for a specific audience.

When requesting feasibility, you should include all required qualifications and condition codes.

Advanced targeting(AT) questions can also be checked for feasibility similar to core qualifications. Get the list of available advanced targeting questions in a locale by doing the GET call to /attributes API.

If a certain qualification_code is not present in the locale that is requested for feasibility, then it would be shown under "unused_qualifications": [] in the response body.

Example:

"unused_qualifications": [
    9756
]

If the condition_codes given under a particular qualification_code are not valid, then it would be shown under "unused_criterias": [] in the response body.

Example:

"unused_criterias": [
    {
        "1031": [
            "11"
        ]
    }
]

Request

Query Params

Body Params application/json

Examples

Example for 50 completes, males aged 18-65Example with unused criteria

{
    "survey_localization": "en_US",
    "completes_required": 50,
    "expected_ir": 99,
    "expected_loi": 20,
    "field_time": 7,
    "quotas": [
        {
            "buyer_quota_id": "abc1",
            "required_count": 50,
            "criteria": [
                {
                    "qualification_code": 211,
                    "condition_codes": [
                        "111"
                    ]
                },
                {
                    "qualification_code": 212,
                    "range_sets": [
                        {
                            "from": 18,
                            "to": 65,
                            "units": 311
                        }
                    ]
                }
            ]
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Example for 50 completes, males aged 18-65Example with unused criteria

curl --location --request POST 'https://staging.spectrumsurveys.com/buyers/v2/feasibility?summary' \
--header 'Content-Type: application/json' \
--data-raw '{
    "survey_localization": "en_US",
    "completes_required": 50,
    "expected_ir": 99,
    "expected_loi": 20,
    "field_time": 7,
    "quotas": [
        {
            "buyer_quota_id": "abc1",
            "required_count": 50,
            "criteria": [
                {
                    "qualification_code": 211,
                    "condition_codes": [
                        "111"
                    ]
                },
                {
                    "qualification_code": 212,
                    "range_sets": [
                        {
                            "from": 18,
                            "to": 65,
                            "units": 311
                        }
                    ]
                }
            ]
        }
    ]
}'

Responses

🟢200Success

application/json

Body

Examples

Without supplier infoWith supplier infoWith unused criteria

Example response for 50 completes with gender male and age between 45 - 49

{
    "quotas": [
        {
            "buyer_quota_id": "abc1",
            "count": 3388
        }
    ],
    "max_feasibility": 0,
    "recommended_cpi": 3.58,
    "unused_criterias": [],
    "unused_qualifications": [],
    "feasibility_cpi": 3.58,
    "total_feasibility": 3388,
    "difficult_quotas": []
}

Modified at 2025-07-19 21:21:31

Feasibility

Attributes

Feasibility & Pricing

Description#

Request

Request Code Samples

Responses

Description