Not yet available on Staging or Production
Overview
Buyers may assign flexibility on supplier allocations from 0% to 100%, where 100% flexibility means any single supplier may achieve 100% of the available completes.
The opposite is true, where 0% flexibility means a supplier may only achieve the completes they have been allocated.
In the event that the minimum achievable by a supplier is greater than 0, this will be communicated in the supply API endpoints for
and
Use
As a supplier, if you have been assigned a guaranteed allocation on a survey, then this will be communicated in the object:
"supplier_completes": {
"needed": 24,
"achieved": 3,
"remaining": 21,
"guaranteed_allocation": 10,
"guaranteed_allocation_remaining": 7
},
Important Considerations
The value of “guaranteed_allocation” may change if the buyer makes adjustments to the supplier selection.
The value of “guaranteed_allocation_remaining” is calculated by ”guaranteed_allocation” - ”achieved”
Request
GET $apihost/$basepath/surveys/:surveyId
($apihost is the environment against which you are testing, and $basepath is the base path with the api version. All Buy API calls will require access-token parameter in the header)
Request:
GET https://api.spectrumsurveys.com/suppliers/v2/surveys/:surveyId
Result
Response Code
200
Response Body
{
"apiStatus": "success",
"msg": "Survey Quota and Qualification fetched successfully ",
"version": "2.0",
"survey": {
"survey_grouping": {
"survey_ids": [
012345
],
"exclusion_period": 30
},
"incl_excl": 0,
"cpi": 2.50,
"supplier_completes": {
"needed": 24,
"achieved": 3,
"remaining": 21,
"guaranteed_allocation": 10,
"guaranteed_allocation_remaining": 7
},
"price_type": 1,
"pii": false,
"buyer_message": "",
"survey_performance": {
"overall": {
"ir": 7,
"loi": 16
},
"last_block": {
"ir": 7,
"loi": 16
}
},
"survey_id": 123456,
"last_complete_date": 1587079259955,
"survey_name": "Exciting New Survey #479329",
"surveyLocalization": "en_US",
"survey_status": 33,
"buyer_id": 163,
"field_end_date": 1588373966682,
"crtd_on": 1587077966685,
"mod_on": 1587079256164,
"click_balancing": 0,
"category": "Exciting New",
"category_code": 232,
"qualifications": [
{
"condition_codes": [
"112",
"111"
],
"qualification_code": 211
},
{
"qualification_code": 212,
"range_sets": [
{
"from": 25,
"to": 35,
"units": 311
},
{
"from": 18,
"to": 24,
"units": 311
},
{
"from": 26,
"to": 35,
"units": 311
}
]
},
{
"condition_codes": [
"112",
"113",
"111"
],
"qualification_code": 219
}
],
"quotas": [
{
"quota_id": "1d36daca-42c0-4cd4-b1ea-9a2e219237d6",
"quantities": {
"currently_open": 5,
"remaining": 50,
"achieved": 3
},
"criteria": [
{
"qualification_code": 219,
"condition_codes": [
"112",
"113"
]
}
],
"crtd_on": 1587077971121,
"mod_on": 1587082329823,
"last_complete_date": 1587082329802
},
{
"quota_id": "1d36daca-42c0-4cd4-b1ea-9a2e219237d5",
"quantities": {
"currently_open": 5,
"remaining": 25,
"achieved": 1
},
"criteria": [
{
"qualification_code": 219,
"condition_codes": [
"111"
]
}
],
"crtd_on": 1587077971121,
"mod_on": 1587082329823,
"last_complete_date": 1587082329802
}
],
"soft_launch": true
}
}
|