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/:survey_id

...

Call this API to view the quota for the survey. You can check out the Criteria section and look for the qualification and condition codes.

Qualification code for children is 218. 


Warning

Targeting for age and gender of child { "qualification_code" : 220 & 230 } will only appear in the criteria of the quota. It will not appear in the qualifications array. This is because that the survey may target for the people who have children as well as for people who don't have children in the same survey.


If a survey is targeting for parents of a specific age and gender of a child , then a qualifications array will always contain qualification_code : 218 and condition_code:111. The Age and gender of the child will appear as a nested quota for qualification_code : 218, 220 and 230.


Please see examples below


HEADER Parameters

Parameter

Type

Required

Description

access-token

string

Yes

Token used to identify the authenticity of the user.



Response Parameters    

Parameter

Type

Description

quota_id

integer

Quota ID

Criteria

Object

Contains Qualification codes and their corresponding condition codes

qualification_code

integer

218 for Children , 220 fro Kid's Gender and 230 for Kid's age.

condition_codesintegerFor 218, 111 stands for No children and 112 for having children.


Sample API Request

Code Block
GET /suppliers/v2/surveys/:survey_id
Host: api.spectrumsurveys.com
access-token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx


Sample API Response

This is a snippet from there response of GET /suppliers/v2/surveys/:survey_id

Code Block
"quotas": [

...


{

...


          "quota_id": "c0013c3d-42e6-4a5f-9097-96c7eea4f155",

...


          "quantities":

...


                 {

...


                       "currently_open": 100,

...


                       "remaining": 100,

...


                       "achieved": 0

...


                  },

...


           "criteria": [

...


                  {

...


                        "qualification_code": 218,

...


                        "condition_codes": [

...


                              "111"

...


                          ]

...


                  },

...


                  {

...


                        "qualification_code": 220,

...


                        "condition_codes": [

...


                              "111"

...


                         ]

...


                  },

...


                  {

...


                        "qualification_code": 230,

...


                        "range_sets": [

...


                                 {

...


                                       "units": 311,

...


                                       "to": 1,

...


                                       "from": 1

...


                                 }

...


                         ]

...


                  }

...


                 ],

...


               "crtd_on": 1505724120171,

...


               "mod_on": 1505724120171

...


}


]