Survey Health Checks

Owned by Ian McCartney
Feb 23, 2024
2 min read

This API provides information about the health of surveys for buyers. It allows you to retrieve the health status of surveys based on specified parameters.

Request

GET Health Check API for API users:

GET <SERVER_BASE_URL>/buyers/v2/surveys/health/status

Parameters:

key

Optional

Description

Possible values

page

yes

Page number for paginated results.

1

limit

yes

Number of items to retrieve per page.

10

survey_ids

yes

Filter surveys by comma separated survey ids.

2304, 4078

alert_level

yes

Filter survey and health data response by alert type.

‘grey’,’ green’, ‘yellow’, ‘red’

health_alert

yes

Filter survey and health data response by health alert type.

‘loi_delta’, ‘ir_delta’, ‘completes_per_hour’, ‘buyer_over_quota’, ‘buyer_drop_rate’, ‘ps_status_ratio’, ‘supplier_dominance’, ‘too_good_to_be_true’, ‘pace’

Response

The API responds with an array of objects, where each object contains the following fields:

  • survey_id (number): ID of the survey.

  • health_data (object): Contains health-related information.

    • health_alert (string): Name of KPI the health refers to. ("IR Delta", "LOI Delta", "Completes Per Hour", "Buyer Over Quota", "Buyer Drop Rate", "PS Status Ratio", "Supplier Dominance", "Too Good to be True", "Pace")

    • alert_level (string): Alert level (GREY, GREEN, YELLOW, RED).

    • survey_health_metric_value (string): Value of the survey health metric.

    • recommendation (array of strings): Recommendations to fix the health of survey for that particular KPI.

 

Sample Request

GET Health Check API for API users:

GET <SERVER_BASE_URL>/buyers/v2/surveys/health/status?page=1&limit=4&alert_level=red&health_alert=buyer_drop_rate&survey_ids=7386,7368

Response:

This example shows a response with the health status of a specific survey with ID 7368, focusing on the "Buyer Drop Rate" Health Check alert. The survey has a red alert level, and the recommendation provides guidance based on the survey's health metric value.

[    {        "survey_id": 7368,        "health_data": [            {                "health_alert": "Buyer Drop Rate",                "alert_level": "RED",                "survey_health_metric_value": "50%",                "recommendation": [                    "50% of transactions are resulting in BUYER DROP status. We have paused this project. After reviewing you can re-launch this project."                ]            }        ]    } ]