PureSpectrum
PureSpectrum websiteHelp center
PureSpectrum websiteHelp center
  1. Surveys
  • Back to home
  • API Reference
  • Feasibility
    • Feasibility & Pricing
  • Attributes
    • Get attribute (V3)
    • Get attributes (V3)
  • Surveys
    • Create survey
      POST
    • Get similar surveys
      POST
    • Create group multi-country surveys
      POST
    • Update survey
      PATCH
    • Update survey
      PUT
    • Update survey status
      PUT
    • Update offer price
      PUT
    • Update group multi-country surveys
      PUT
    • Get survey information
      GET
    • Get survey status
      GET
    • Get survey performance
      GET
    • Get list of all surveys
      GET
    • Surveys health status
      GET
    • Pacing details
      GET
    • Delete survey
      DELETE
  • Qualifications
    • Add qualification
    • Update qualification
    • Get qualification information
    • Get all qualifications
    • Delete qualification
  • Quotas
    • Add quota
    • Update quota
    • Update quota
    • Get quota information
    • Get quota performance
    • Delete quota
  • Survey group exclusions
    • Create exclusion group
    • Update exclusion group
    • Get exclusion group information
    • Delete exclusion group
  • Respondent inclusion / exclusion
    • Add a PSIDref list to a survey
    • Update a PSIDref for survey
    • Get PSIDref list for survey
  • Supplier management
    • Create supplier blend
    • Update the list of suppliers for a survey
    • Get list of available suppliers in a locale
    • Get list of available suppliers for a survey
    • Get list of supplier blends
  • Traffic Channels
    • Create traffic channel
    • Get a list of traffic channels
  • Transactions
    • Update status of transaction (V2)
    • Update status of transaction (V3)
    • Register transaction as complete
    • Get transaction status (V3)
    • Get transaction info (V3)
    • Get transactions info for a survey ID (V3)
  • Reconciliation
    • Survey reconciliation
    • Multi survey reconciliation
    • Get status of a reconciliation request
    • Get reconciliation status for an adjustment ID
  • PureText
    • PureText Open-ended (OE) check (V3)
  • Activity logs
    • Get activity logs
    • Get events
  • Templates
    • Get survey templates
  1. Surveys

Surveys health status

GET
/surveys/health/status
Last modified:2025-10-05 16:51:01

Description#

This endpoint provides information about the health of your surveys. It allows you to retrieve the health status of surveys based on specified parameters.
Example:
GET /surveys/health/status?page=1&limit=4&alert_level=red&health_alert=buyer_drop_rate&survey_ids= 41234567, 41234568

Request

Authorization
Add parameter in header
access-token
Example:
access-token: ********************
Query Params

Request Code Samples

Shell
JavaScript
Java
Go
PHP
Python
C#
Ruby
Request Request Example
Shell
JavaScript
Java
Go
curl --location '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>'

Responses

🟢200Success
application/json
Bodyapplication/json

Example
[
    {
        "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%"
            }
        ]
    }
]
🟠401Unauthorized
Modified at 2025-10-05 16:51:01
Previous
Get list of all surveys
Next
Pacing details