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 |
languages | Array of Strings | Language name,Language code |
supplier_completes | Object | Contains completes needed, achieved, and remaining |
ir | Integer | Conversion rate |
loi | Integer | Loi in minutes |
cpi | Integer | Cpi value (in the native currency of the country) |
field_start_date | Date | |
field_end_date | Date | |
category | String | The category of the survey |
category_code | integer | Survey Category Code |
last_complete_date | timestamp | |
| crtd_on | timestamp (UTC) | |
| mod_on | timestamp (UTC) |
Sample API Request
GET /suppliers/surveys HTTP/1.1 Host: api.spectrumsurveys.com Content-Type: application/x-www-form-urlencoded access_token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx supplier_id: 9999
Sample API Response
{
"survey_id": 825,
"cpi": 6,
"survey_status": 22,
"survey_name": "Automotive Survey #825",
"surveyLocalization": "en_US",
"category": "Automotive"
"category_code": 211,
"field_end_date": "2016-09-27",
"last_complete_date": "2016-09-26",
"supplier_completes": {
"needed": 257,
"achieved": 0,
"remaining": 257
},
"survey_performance":{
"overall":{
"ir": 80,
"loi": 6,
},
"last_block":{
"ir": 80,
"loi": 6,
}
},
"survey_grouping": {
"survey_ids": [
1373
],
"exclusion_period": 90
},
"crtd_on":124411231313,
"mod_on":11321334733
}