| Code Block |
|---|
Get Surveys - GET /surveys - https://api.spectrumsurveys.com/suppliers/v2/surveys |
...
"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
mod_on query string param
The “mod_on” query string parameter can be used to filter the surveys returned in the response, so that you only get surveys that have been modified since the timestamp you submit.
| Info |
|---|
We will limit the max time that someone may pass, is |
Examples:
/surveys?mod_on=1700630207049
survey_status query string param
The “survey_status” query string parameter can be used to filter the surveys returned in the response, so that you receive surveys in a specific status.
| Note |
|---|
If the parameter is missing, the default value is LIVE surveys only (status=22). If you use this parameter for any status other than LIVE surveys (e.g. 22), then you must pass in a mod_on that is newer than the max timestamp. |
22 - Returns LIVE surveys
33 - Returns PAUSED surveys
44 - Returns CLOSED surveys
| Info |
|---|
You may string together statuses, comma separated |
Examples:
/surveys?mod_on=1700630207049&survey_status=33,44
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 |
. | ||
survey_grouping.survey_ids | Array | If a respondent has previously taken any of these surveys, they will be excluded |
. | ||
survey_grouping.exclusion_period | Number | This |
field may be ignored. | ||
purescore | Number | 0 indcates that a survey will accept any respondent, regardless of PureScore. 1 indicates that a survey will accept only respondents with a passing PureScore. If a respondent has ever failed with ps_rstatus=42, avoid sending them to surveys with PureScore = 1. See https://purespectrum.atlassian.net/wiki/spaces/PA/pages/33613201 |
Sample API Request
| Code Block |
|---|
GET /suppliers/v2/surveys/ Host: api.spectrumsurveys.com access-token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
...