Get Surveys - GET /surveys - http://api.spectrumsurveys.com/suppliers/v2/surveys
Call this API to view surveys that your Supplier account has an allocation for. You are expected to Register Intent & send sample to these surveys.
You can use this method to check the status of existing surveys you are delivering on, including current LOI, IR, & CPI.
HEADER Parameters
Parameter | Type | Required | Description |
|---|---|---|---|
access-token | string | Yes | Token used to identify the authenticity of the user. |
Response Parameters
Parameter | Type | Description |
|---|---|---|
survey_id | integer | Survey ID |
survey_name | String | Name of survey |
survey_status | String | 11 for draft, 22 for live, 33 for paused, 44 for closed |
supplier_completes | Object | Contains completes needed, achieved, and remaining |
survey_performance | Object | Contains Overall & Last Block IR & LOI |
overall | Object | This performance corresponds to IR & LOI since survey start |
last_block | Object | This performance corresponds to IR & LOI in the last block |
ir | Integer | Conversion rate |
loi | Integer | Loi in minutes |
cpi | Integer | Cpi value |
field_end_date | UTC Timestamp in milliseconds since Unix Epoch | |
category | String | The category of the survey |
category_code | integer | Survey Category Code |
last_complete_date | UTC Timestamp in milliseconds since Unix Epoch | |
| crtd_on | UTC Timestamp in milliseconds since Unix Epoch | |
| mod_on | UTC Timestamp in milliseconds since Unix Epoch | |
| buyer_id | Integer or Null | |
| surveyLocalization | string | 2 letter code for language, followed by underscore, followed by 2 letter code for country (according toISO 3166) |
| survey_grouping | Object | If a respondent has previously taken any of these surveys, they will be excluded if that survey was taken in the exclusion_period. |
| survey_grouping.survey_ids | Array | If a respondent has previously taken any of these surveys, they will be excluded if that survey was taken in the exclusion_period. |
| survey_grouping.exclusion_period | Number | This is the number of days for which a respondent is disqualified from taking another survey in the same survey group. |
Sample API Request
GET /suppliers/v2/surveys/ Host: api.spectrumsurveys.com access-token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Sample API Response
"quotas": [
{
"quota_id": "c0013c3d-42e6-4a5f-9097-96c7eea4f155",
"quantities": {
"currently_open": 100,
"remaining": 100,
"achieved": 0
},
"criteria": [
{
"qualification_code": 218,
"condition_codes": [
"111"
]
},
{
"qualification_code": 220,
"condition_codes": [
"111"
]
},
{
"qualification_code": 230,
"range_sets": [
{
"units": 311,
"to": 1,
"from": 1
}
]
}
],
"crtd_on": 1505724120171,
"mod_on": 1505724120171
}
]