Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

...

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

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 (in the native currency of the country)

field_end_date

timestamp (UTC)UTC Timestamp in milliseconds since Unix Epoch


category

String

The category of the survey

category_code

integer

Survey Category Code

last_complete_date

timestamp (UTC)UTC Timestamp in milliseconds since Unix Epoch


crtd_ontimestamp (UTC)UTC Timestamp in milliseconds since Unix Epoch
mod_ontimestamp (UTC)UTC Timestamp in milliseconds since Unix Epoch
surveyLocalizationstring2 letter code for language, followed by underscore, followed by 2 letter code for country (according to

ISO 3166)

survey_groupingObjectIf 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_idsArrayIf 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_periodNumberThis is the number of days for which a respondent is disqualified from taking another survey in the same survey group.

...