...
...
...
...
...
...
...
...
...
| Code Block |
|---|
Get Surveys - |
...
GET /surveys - |
...
https://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 also can use this API call to check the status of existing surveys you are delivering sample to, including current LOI, IR, & CPI.
Registered query string param
The "reg" query string parameter can be used to filter the surveys returned in the response.
"false" - Returns only surveys where the Supplier has not registered intent
"true" - Returns only surveys where the Supplier has registered intent
"both" - Returns all surveys (default)
Examples:
/surveys?reg=false
/surveys?reg=true
/surveys?reg=both
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 | ||
click_balancing | Boolean | Indicates whether the survey is click balancing or not. “1" for yes, “0" for no. When “click_balancing” = “1”, the survey is counting clicks rather than completes and the numbers shown in the API response are reflective the number of clicks needed, achieved, remaining, etc. |
buyer_id | Integer or Null | |
surveyLocalization | string | 2 letter code for language, followed by underscore, followed by 2 letter code for country (according to ISO 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
| Code Block |
|---|
GET /suppliers/v2/surveys/ Host: api.spectrumsurveys.com access-token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
...