GET suppliers/v2/surveys/:survey_id
https://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.
...
Parameter | Type | Description |
|---|---|---|
survey_id | Number | This is the PureSpectrum survey ID |
survey_status | Number | Indicates the Survey's current status. 11 for draft, 22 for live, 33 for paused, 44 for closed |
| surveyLocalization | String | 2 letter code for language, followed by underscore, followed by 2 letter code for country (according to ISO 3166). Only one localization per survey is allowed. (Apologies for the use of camelCase instead of snake_case for the Parameter key) |
survey_performance | Object | Contains Overall & Last Block IR & LOI |
overall | Object | This performance corresponds to IR & LOI since survey start |
last_block | Object | This performance corresponds to IR & LOI in the last block |
ir | integer (1-100) | This is the Incidence Rate of the performance period. Divide by 100 to get the percentage. E.G. 60% is returned as 60 by IR. IR is defined as Completes/(Completes+Buyer_Terminations+Buyer_Drop+Buyer_OverQuota) |
loi | Integer (1-120) | This is the Median LOI of the performance period. |
qualifications | Array of Objects | This array contains all qualification codes upon which certain condition codes are applied. If a qualification code is absent, PureSpectrum will not check this particular qualification for each respondent. A qualification's absence also means that no quota will be applied on that qualification code. |
qualification_code | Number | Purespectrum code for the qualification. |
condition_codes | Array of Strings | This array is part of the qualification hash, referring to it's preceding qualification_code. If more than one condition code is present, handle the additional condition codes as an OR operator. For example, if for race (qualification 214), condition codes "111","112","114" are present, the respondent may either be White, Hispanic, or Asian to qualify for the survey. |
range_sets | Object | Contains the from, to, and units if the question type is "range" |
from | Number | Specifies the starting point for the range |
to | Number | Specifies the ending point for the range |
units | Number | Specifies the unit type according to Quotas & Qualifications V2#units table found on the bottom of this page |
quotas | Array | Array containing the quota objects of a survey. If no quotas have been specified by the buyer, then we will display a default quota for ages 13-99. |
quota_id | String | This is the internal PureSpectrum ID for the quota. |
criteria | Array | Contains the targeting criteria objects of an individual quota |
quantities | Object | Contains completes needed, achieved, remaining, & open_quantity. open_quantity is the amount that indicates the number of completes currently available to be filled in this quota |
currently_open | Number | Number of completes currently available in the quota. If the value is 0, any respondent matching this quota will be rejected. |
achieved | Number | Quantity within this quota ID that your supply has completed |
remaining | Number | Theoretical Number of completes remaining for your supply |
crtd_on | UTC Timestamp in milliseconds since Unix Epoch | Timestamp of when this quota id was created (milliseconds since Unix Epoch) |
mod_on | UTC Timestamp in milliseconds since Unix Epoch | Timestamp of when this quota id was last modified. This would only change if the quota is locked/unlocked, or the quantity is changed. If a quota's criteria are modified, this quota is closed and a new one is created. (milliseconds since Unix Epoch) |
field_end_date | UTC Timestamp in milliseconds since Unix Epoch | Timestamp of when this survey is scheduled to end fielding. The survey may stay open past fielding at the buyer's discretion. |
| click_balancing | Boolean | Indicates whether the survey is click balancing or not. “1" for yes, “0" for no. When “click_balancing” = “1”, the survey is counting clicks rather than completes and the numbers shown in the API response are reflective the number of clicks needed, achieved, remaining, etc. |
| buyer_message | String | The buyer may choose to add a custom message to their survey. This message is present here, limited to 500 characters. If no message is present, this will display as the empty string "" |
| pii | bool | Indicates whether the survey requires PII. True for yes, False for no. |
| price_type | Number | Not currently live on production and all responses will come back with the same value
1-priced according to the rates you have provided via price card or formulas 2-priced according to preferred rate card negotiated with buyer 3-priced according to operator override //this is a price that has been manually modified by a PureSpectrum employee 4-programmatic direct //details to come 5-priced according to API response //details to come |
| buyer_id | Number | This is the buyer's company ID that will be useful in determining your performance with different buyers in the marketplace. If applicable, the buyer id will be displayed. In all other cases, the buyer id will be NULL. |
| survey_grouping | Object | If a respondent has previously taken any of these surveys, they will be excluded if that survey was taken in the exclusion_period. If there are no survey grouping id's present, this will return an empty object. |
| survey_ids | Array | If a respondent has previously taken any of these surveys, they will be excluded if that survey was taken in the exclusion_period. |
| exclusion_period | Number | This is the number of days for which a respondent is disqualified from taking another survey in the same survey group. |
...