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.

...

Code Block
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

Code Block
{
      "survey_id": 825,
	  "cpi": 6,
      "survey_status": 22,
      "survey_name": "Automotive Survey #825",
      "surveyLocalization": "en_US",
	  "category": "Automotive"
      "category_code": 211,
      "field_end_date": 1487886077000,
      "last_complete_date": 1487891732857,
      "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
}

...