...
...
...
...
...
...
...
...
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.
...
| Warning |
|---|
In case targeting is present on either age of child or gender of child, a nested quota will be present containing age of child, gender of child, and parent qualification codes. (218, 220, 230). |
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 - parent/not parent 220 - gender of child 230 - age of child |
| condition_codes | array of strings | Contains the applicable answer choices for either 218 (has/doesn't have children) or 220 (gender of the child) |
| range_sets | array of objects | Contains range sets for the age of the child, nested within the criteria of a quota. |
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) |
Range Sets - Object Parameters
Parameter | Type | Description |
|---|---|---|
from | integer | Quota ID |
to | integer | Contains Qualification codes and their corresponding condition codes |
units | integer | 311 - Years 312 - Months |
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
...