We hope you enjoy our updated documentation! The old documentation website is still available here. Reach out to us with feedback or questions. Happy programming! 🎉
access-token: ********************
curl --location --request GET 'https://staging.spectrumsurveys.com/buyers/v2/surveys/health/status?page=1&limit=10&survey_ids=2304&survey_ids=4078&alert_level=red&health_alert=loi_delta' \
--header 'access-token: <api-key>'
[
{
"survey_id": 41234567,
"health_data": [
{
"health_alert": "Buyer Drop Rate",
"alert_level": "GREEN",
"survey_health_metric_value": "5.93%"
},
{
"health_alert": "Buyer Over Quota",
"alert_level": "GREEN",
"survey_health_metric_value": "0%"
},
{
"health_alert": "Completes Per Hour",
"alert_level": "GREEN",
"survey_health_metric_value": "16 Complete/s"
},
{
"health_alert": "Pace",
"alert_level": "RED",
"survey_health_metric_value": "-124.05%",
"recommendation": [
"You are -124.05% short of Completes Per Hour to complete your project within the scheduled Field Time. Consider making updates to CPI and/or launching Traffic Channels to increase delivery."
]
},
{
"health_alert": "IR Delta",
"alert_level": "RED",
"survey_health_metric_value": "-39%",
"recommendation": [
"Over Quota alarm is also 'Red'",
"Please ensure that quotas that are full on the Survey are also full in PureSpectrum.",
"If survey quotas are not full, and PS quotas are not full, the next step is to check the survey programming",
"Other Options",
"There could be an error in programming that is terminating users at unanticipated rate.",
"If survey programming is functional, you should consider adjusting your price to reflect this new IR."
]
},
{
"health_alert": "LOI Delta",
"alert_level": "GREEN",
"survey_health_metric_value": "-1 minute/s"
},
{
"health_alert": "PS Status Ratio",
"alert_level": "GREEN",
"survey_health_metric_value": "14.02%"
},
{
"health_alert": "Supplier Dominance",
"alert_level": "GREEN",
"survey_health_metric_value": "16.64%"
},
{
"health_alert": "Too Good to be True",
"alert_level": "YELLOW",
"survey_health_metric_value": "14.29%",
"recommendation": [
"One or more suppliers' IR is higher than the average IR of other Suppliers in this survey."
]
}
]
},
{
"survey_id": 41234568,
"health_data": [
{
"health_alert": "Buyer Drop Rate",
"alert_level": "GREEN",
"survey_health_metric_value": "8.33%"
},
{
"health_alert": "Buyer Over Quota",
"alert_level": "GREEN",
"survey_health_metric_value": "0%"
},
{
"health_alert": "Completes Per Hour",
"alert_level": "RED",
"survey_health_metric_value": "0 Complete/s",
"recommendation": [
"This project has seen no completes in the last hour and may require attention"
]
},
{
"health_alert": "Pace",
"alert_level": "GREEN",
"survey_health_metric_value": "0%"
},
{
"health_alert": "IR Delta",
"alert_level": "GREY",
"survey_health_metric_value": "N/A"
},
{
"health_alert": "LOI Delta",
"alert_level": "GREY",
"survey_health_metric_value": "N/A"
},
{
"health_alert": "PS Status Ratio",
"alert_level": "RED",
"survey_health_metric_value": "79.57%",
"recommendation": [
"79.57% of transactions are resulting in a PS Status. This is abnormally high, possible actions include:",
"Test the screener process.",
"Check the Advanced Targeting makeup and ensure you are using a “Supplier Mapped” question.",
"Check with your Account Manager or Support@PureSpectrum.com"
]
},
{
"health_alert": "Supplier Dominance",
"alert_level": "GREEN",
"survey_health_metric_value": "6.67%"
},
{
"health_alert": "Too Good to be True",
"alert_level": "GREEN",
"survey_health_metric_value": "0%"
}
]
}
]