Versions Compared

Key

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

Get Quotas & Qualifications - GET suppliers/v2/surveys/:survey_id

 - http://api.spectrumsurveys.com/suppliers/v2/surveys/:survey_id

ORDER OF OPERATIONS

 Please read the Respondent Order of Operations in order to understand the PureSpectrum targeting flow.

...

Code Block
    "quotas":[
        //example quota on single age range
		{
            "quota_id": "123",
            "criteria":[{
                    “qualification_code”: 212,
            		"range_sets":[{"from":13,"to":18,“units”:“111”}]
       			 }
            ],
            "quantities":{
                "currently_open":100,
                "remaining":100,
                "achieved":0
            },
            "crtd_on":124411231313,
            "mod_on":11321334733
        },
        //example quota with a single condition on Race
		{
            "quota_id": "123",
            "criteria":[{
                    “qualification_code”: 214,
            		"condition_codes":["111"]
       			 }
            ],
            "quantities":{
                "currently_open":100,
                "remaining":100,
                "achieved":0
            },
            "crtd_on":124411231313,
            "mod_on":11321334733
        },
        //example quota with OR condition on Race
		{
            "quota_id": "123",
            "criteria":[{
                    “qualification_code”: 214,
            		"condition_codes":["111","112","114"]
       			 }
            ],
            "quantities":{
                "currently_open":100,
                "remaining":100,
                "achieved":0
            },
            "crtd_on":124411231313,
            "mod_on":11321334733
        },
        //example quota with nested conditions for gender and age
		{
            "quota_id": "123",
            "criteria":[{
                    “qualification_code”: 211,
            		"condition_codes":["111"]
       			 },
				 {
                    “qualification_code”: 212,
            		"range_sets":[{"from":13,"to":18,“units”:“111”}]
       			 }
            ],
            "quantities":{
           		"currently_open":100,
                "remaining":100,
                "achieved":0
            },
            "crtd_on":124411231313,
            "mod_on":11321334733
        },
		//example quota showing temporary exclusion - currently_open=0, remaining=0, achieved=0
		{
            "quota_id": "123",
            "criteria":[{
                    “qualification_code”: 211,
            		"condition_codes":["111"]
       			 },
				 {
                    “qualification_code”: 212,
            		"range_sets":[{"from":13,"to":18,“units”:“111”}]
       			 }
            ],
            "quantities":{
            	"currently_open":0,
                "remaining": 0,
                "achieved":0
            },
            "crtd_on":124411231313,
            "mod_on":11321334733
        }
    ],
	"crtd_on":124411231313,
	"mod_on":11321334733
	}


	//example locked quota
	{
            "quota_id": "123",
            "criteria":[{
                    “qualification_code”: 211,
            		"condition_codes":["111"]
       			 },
				 {
                    “qualification_code”: 212,
            		"range_sets":[{"from":13,"to":18,“units”:“111”}]
       			 }
            ],
            "quantities":{
           		"currently_open":0,
                "remaining": 100,
                "achieved":0
            },
            "crtd_on":124411231313,
            "mod_on":11321334733
        }
    ],
	"crtd_on":124411231313,
	"mod_on":11321334733
	}


//unusual quotas
        //example quota with multiple age range
		{
            "quota_id": "123",
            "criteria":[{
                    “qualification_code”: 212,
            		"range_sets":[{"from":13,"to":18,“units”:“111”},{"from":45,"to":54,“units”:“111”}]
       			 }
            ],
            "quantities":{
                "currently_open":100,
                "remaining":100,
                "achieved":0
            },
            "crtd_on":124411231313,
            "mod_on":11321334733
        }

]

Child Quota

If the buyer is looking for parents, the quota would look like:

Code Block
 "qualifications": [{
        "qualification_code":218,
        "condition_codes": ["111","112"] //has kids or no kids, either is okay.  If only 111, then must have children.
        },
        {
		"qualification_code":230,
        "range_sets":[{"from":6,"to":18,"units":312},{"from":3,"to":6,"units":311}], //looking for ages 6 to 18 months, or 3 to 6 years old.
        },
        "qualification_code":220,
        "condition_codes": ["111"] //Looking for parents of boys only.  112 would designate girls.
        },


//buyer looking for a 3-6 year old boy

"quotas":[{
	"quota_id" : "123",
	"criteria":[{
   		"qualification_code": 220,
 	 	"condition_code": ["111"]
  	},
  	{
 		"qualification_code": 230,
  	 	"range_sets": {
	   	"from": 3,
	   	"to": 6,
 	    "units": 311
 	  }
  }
 ]
},

//buyer looking for parents of 3-6 month old either gender
	{
	"quota_id":"123",
	"criteria":[{
   		"qualification_code": 220,
 	 	"condition_code": ["111","112"]
  	},
  	{
 		"qualification_code": 230,
  	 	"range_sets": {
	   		"from": 3,
	   		"to": 6,
 	   		"units: 312
 	 }	
   }
  ]
 }

}


Advanced Targeting Example with Movie Theater Frequency Question

...