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
ISO 3166)
Sample API Request
| Code Block |
|---|
GET /suppliers/v2/surveys/ Host: api.spectrumsurveys.com access-token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
...