Retrieving a Specific Survey

You may use this endpoint to retrieve a specific survey in your account.

Request


GET $apihost/$basepath/surveys

($apihost is the environment against which you are testing,  All Buy API calls will require access_token parameter in the header) 

Query String Parameters:

Response Parameter

Type

Description 

Example

Response Parameter

Type

Description 

Example

targeting

integer - enum:

1: returns the normal survey response with qualification and quota arrays. (default)

0: suppresses the qualifications and quotas array to reduce response size

Using targeting=0 will suppress the response of the qualifications and quotas array

targeting=0

Sample Request: 

GET api.spectrumsurveys.com/buyers/v2/surveys/123456

Response


Response Code

200

Response Body

{ "click_balancing": 0, "estimated_clicks": 0, "ps_survey_status": 11, "offer_price": 10, "incl_excl": 0, "survey_title": "Test Survey 1 ", "live_url": "http://mysurvey.com/survey/1", "test_url": "http://mysurvey.com/survey/1?test=true", "completes_required": 3000, "field_time": 99, "uniqueLinks": false, "survey_category_code": 231, "expected_loi": 10, "expected_ir": 10, "ps_survey_id": 123456, "buyer_surveygroup_ref": null, "test_ps_survey_entry_link": "https://spectrumsurveys.com/#/start-survey?survey_id=123455&supplier_id=23", "survey_localization": "en_US", "qualifications": [ { "qualification_code": 212, "range_sets": [ { "from": 13, "to": 89, "units": 311 } ] }, { "condition_codes": [ "1" ], "qualification_code": 225 }, { "condition_codes": [ "111", "112" ], "qualification_code": 214 } ], "quotas": [ { "buyer_quota_id": "qb12", "ps_quota_id": "55812aad-03bd-4cd9-ac28-8246bc89d78c", "required_count": 400, "criteria": [ { "qualification_code": 225, "condition_codes": [ "1" ] } ] }, { "buyer_quota_id": "qb13", "ps_quota_id": "2bc64c3b-811b-4253-9398-ec9535a8c8fe", "required_count": 600, "criteria": [ { "qualification_code": 214, "condition_codes": [ "111" ] } ] }, { "buyer_quota_id": "qb14", "ps_quota_id": "36885459-f6de-4b3c-a326-a262c8504657", "required_count": 200, "criteria": [ { "qualification_code": 212, "range_sets": [ { "units": 311, "to": 50, "from": 13 }, { "units": 311, "to": 89, "from": 51 } ] } ] } ] }