Connecting to the API

The PureSpectrum API is a REST based API.


URL Structure

1 2 3 {Base URI}/{Module}/{API Version}/{Resource} eg: https://staging.spectrumsurveys.com/buyers/v2/surveys  

Base URLs

Base URL - API Staging: https://staging.spectrumsurveys.com/buyers/v2

Base URL - UI Staging: https://stagingplatform.spectrumsurveys.com/

Base URL - API Production: https://api.spectrumsurveys.com/buyers/v2

Base URL - UI Production: https://platform.purespectrum.com

Modules

  • buyer

Resources

Verb

Resource

Description

Verb

Resource

Description

POST

/surveys

Create survey

PATCH

/surveys/:survey_id

Update survey status

GET

/surveys/:survey_id

Get survey information

PUT

/surveys/:survey_id

Edit survey

DEL

/surveys/:survey_id

Delete survey

POST

/surveys/:survey_id/qualifications

Create qualification

GET

/surveys/:survey_id/qualifications/:qualification_id

Get qualification information

PUT

/surveys/:survey_id/qualifications/:qualification_id

Update qualification information

DEL

/surveys/:survey_id/qualifications/:qualification_id

Delete qualification

POST

/surveys/:survey_id/quotas

Create quota

PATCH

/surveys/:survey_id/quotas/:quota_id

Update quota

GET

/surveys/:survey_id/quotas/:quota_id

Get quotas by Quota ID

PUT

/surveys/:survey_id/quotas/:quota_id

Add quota

DEL

/surveys/:survey_id/quotas/:quota_id

Delete quota

GET

/surveys/:survey_id/status

Get survey status

GET

/surveys/:survey_id/performance

Get survey performance

GET

/surveys/:survey_id/quotas/performance

Get quota performance

POST

/surveys/:survey_id/PSIDRef

Create PSID reference list

PATCH

/surveys/:survey_id/PSIDRef

Update PSID reference list

GET

/surveys/:survey_id/PSIDRef

Get PSID reference list

GET

/surveygroups/:survey_group_id

Get survey group

PUT

/surveygroups/:survey_group_id

Edit survey group

DEL

/surveygroups/:survey_group_id

Delete survey group

POST

/surveygroups/:survey_group_id

Create survey group

Response Content Type

  • application/JSON

API access requires an authorization parameter in the request header.


Each request needs to include your API access token.  

Parameter

Type

Required

Description

Parameter

Type

Required

Description

access-token

String

Yes

Token used to identify the authenticity of the user.



Example:  headers: { 'access-token': '$accessToken' }


Please do not expose your access-token to anyone or in public as this could compromise the Integrity of your integration.

Access tokens are issued by your PureSpectrum representative.