Results API

Please note, these docs are for the v1 version of IntelliProve and have been deprecated. They are here for reference of existing customers still using the v1 product.
If you are a new customer, refer to the Technical documentation -v2 .

Introduction

This is the API documentation for the IntelliProve results API, which allows you to request results for past health checks based on the health check UUID.

Prerequisites

If you are new to this developer portal, we recommend first reading the Plug-in: overview, a five-minute read which will get you acquainted with how our plug-in works and how it can be integrated into your platform. To integrate the plug-in into your platform, follow our Plug-in documentation.

Keep in mind that this API is mainly geared towards backend functionality such as requesting results of past health checks, getting history for specific users, deleting data, etc. The actual health check is performed using our web plug-in.

Setup

Environments

As a customer, you will receive information about the environment (API base URL) to use for development and production.

Authentication

All the endpoints described below require an API key or a bearer token in the header for authentication purposes.

API Key

An API key forms a permanent access key to authenticate with the API. Your API key should never be exposed in your front-end and only be used on protected servers and back-end systems.

API keys are sent in the header of the request:
x-api-key: <your-api-key>

No API key and interested in our product? Contact us (info@intelliprove.com) or set up a call

Action Tokens

These are JWT Tokens with an expiry date that only provide access to ‘action routes’. They are generated with your API key and are perfect for doing API calls from front-end applications. Action Tokens have a max lifetime of 12 hours.

Action tokens are sent in the header of the request:
authorization: Token <ActionToken>

You can use our Create action token endpoint to request one.

For security reasons, action tokens only provide access to a restricted set of routes. The available routes are listed below:

• “Get results” route

Results by measurement UUID

We provide the results in two different formats: simple ‘results’ and ‘buckets’.

The simple results of a health check contain the values for each biomarker, without further context. The buckets contain more context, such as the optimum, max and minimum for each biomarker.

The meaning of the ‘results’ and ‘bucket’ objects is further explained in the Message events. More information about the actual biomarkers we measure can be found on the following page: Insights & biomarkers

---

Use the below endpoint to request the results of a previously performed health check. Note that we recommend listening to events, as described in Plug-in: events, in case you want to obtain the results right after the user completes the measurement.

---

Whereas the above endpoint returns immediately if no results are available (yet), some use cases might require the use of long polling to wait while your video is still processing.

Wait for results

GEThttps://engine.intelliprove.com/v1/results/wait/{uuid}

This request long-polls our database for up to 20 seconds, returning the results as soon as they are available or returning a HTTP 202 if no results were found after this time has expired.

Path parameters

uuidstring

required

The uuid of the health check for which to fetch the results

Request

curl

curl --location 'https://engine.intelliprove.com/v1/results/wait/your-video-uuid' \
--header 'Accept: application/json' \
--header 'x-api-key: your-api-key'

Response

200

{
    "timestamp_epoch": 1670921835,
    "timestamp": "2022-12-13T08:57:15+00:00",
    "heart_rate": 112,
    "respiratory_rate": 13,
    "heart_rate_variability": 161,
    "ans_balance": 1,
    "resonant_breathing_score": 30,
    "morning_readiness": 7,
    "acute_mental_stress_score": 3,
    "mental_health_risk": 1
}

202

{
    "detail": "The results for this video were not found. This could be because the video with the specified UUID was never requested for processing, or because it is still being processed."
}

401

{
    "detail": "Missing or invalid authentication credentials."
}

422

{
    "errorCode": 5,
    "errorType": 'VideoError'
    "errorDescription": "The subject's face moved (partially) out of frame during the recording."
}

If the measurement was successfully processed, you will receive the biomarkers in json format, as shown in the example responses above with the HTTP 200 status code.

However, in case the video did not meet the Video input requirements, an error code will be returned to the body of the response. Refer to the example response above with HTTP 422 status.

The error code refers to why the video could not be processed. Examples of input requirements not being met, include too little light, excessive movement of the subject during the video, or a framerate that is too low.

A list of all possible error codes, their explanation and suggested messages towards the user can be found in the table below (click open with the arrow).

List of possible result error codes

Result Error Code	Error Type	Explanation
1	VideoFileError	The device or camera lacks the necessary performance for conducting a high-quality health scan. We recommend using another device with a better quality camera
2	VideoTooShortError	The video is not long enough
21	FpsTooLowError	The video does not meet the minimal FPS threshold.
22	CodecNotSupportedError	The video codec is not in the list of supported codecs.
23	BitrateTooLowError	The video bitrate does not meeting our minimal bitrate threshold.
3	NoFaceDetectedError	A face could not be accurately detected in the video.
4	InsufficientVisibleSkinError	Insufficient skin is visible, e.g. due to the face being partially covered, making an accurate health scan unfeasible.
5	MovedOutOfFrame	The subject’s face (partially) moved out of frame during the recording.
99	UnexpectedError	Something unexpected happened. We will look into this.

In some cases, the video quality or lighting conditions might be insufficient to calculate certain parameters which rely on very subtle fluctuations, such as SDNN, but sufficient for other parameters like HR and RR. In these cases, the response will contain a None for the parameters for which quality was insufficient

---

The buckets corresponding to a health check can be requested using the below endpoint.

Get all buckets

GEThttps://engine.intelliprove.com/v1/buckets/all/{uuid}

Get all the buckets corresponding to a health check.

Path parameters

uuidstring

required

The uuid of the health check for which to fetch the buckets

Request

curl

curl --location 'https://engine.intelliprove.com/v1/results/wait/your-video-uuid' \
--header 'Accept: application/json' \
--header 'x-api-key: your-api-key'

Response

200

{
    "uuid": "4b7b6dc34ddd413e8ce14dbac8e640c4",
    "buckets": [
        {
            "name": "physical",
            "timestamp_epoch": 1707081928,
            "timestamp": "2024-02-04T22:25:28+01:00",
            "status": "bad",
            "biomarkers": [
                {
                    "name": "heart_rate",
                    "value": 88.0,
                    "zone": "bad",
                    "unit": "bpm",
                    "range": [
                        36.0,
                        216.0
                    ],
                    "optimum": "low"
                },
                {
                    "name": "respiratory_rate",
                    "value": 7.0,
                    "zone": "good",
                    "unit": "brpm",
                    "range": [
                        4.0,
                        48.0
                    ],
                    "optimum": "middle"
                }
            ],
            "history": [
                {
                    "biomarkers": {
                        "heart_rate": 77.0,
                        "respiratory_rate": 15.0
                    },
                    "timestamp_epoch": 1708030833,
                    "timestamp": "2024-02-15T22:00:33+01:00"
                },
                {
                    "biomarkers": {
                        "heart_rate": 62.0,
                        "respiratory_rate": 11.0
                    },
                    "timestamp_epoch": 1708029278,
                    "timestamp": "2024-02-15T21:34:38+01:00"
                },
                }
            ]
        },
        {
            "name": "mental",
            "timestamp_epoch": 1707081928,
            "timestamp": "2024-02-04T22:25:28+01:00",
            "status": "good",
            "biomarkers": [...],
            "history": [...]
        },
        ...
    ]
}

400

{
    "detail": "Measurement with UUID not found!"
}

401

{
    "detail": "Missing or invalid authentication credentials."
}

422

{
    "errorCode": 5,
    "errorType": 'VideoError'
    "errorDescription": "The subject's face moved (partially) out of frame during the recording."
}

---

The below endpoint allows you to fetch the summary and tips corresponding to each bucket.

Get bucket summaries

GEThttps://engine.intelliprove.com/v1/buckets/summary/{UUID}

Get the summary and tip for each of the buckets of a health check.

Path parameters

uuidstring

required

The uuid of the health check for which to fetch the buckets

Query parameters

include_tipsBoolean	optional	Whether to include a tip for each bucket
languagestring	optional	The language in which to return the results

Request

curl

curl --location 'https://engine.intelliprove.com/v1/results/wait/your-video-uuid' \
--header 'Accept: application/json' \
--header 'x-api-key: your-api-key'

Response

200

{
    "uuid": "5059844c0c3441e28bda2679995622b5",
    "summaries": [
        {
            "name": "physical",
            "summary": "Your heart rate is 80 beats per minute, which indicates good cardiovascular health. In a normal range for healthy adults without stress. We've detected a breathing frequency of 12 breaths per minute which is very normal.",
            "tip": "Based on your heart rate and respiratory rate, a healthy habit you could incorporate is practicing mindfulness meditation for 10 minutes each day to reduce stress and promote mental well-being."
        },
        {
            "name": "mental",
            "summary": "Your HRV is in a very good range, indicating a non-stressful condition. Your Autonomic Nervous System is relatively balanced, suggesting good regulation between the sympathetic and parasympathetic systems. You have a low mental health risk.",
            "tip": "To further improve your mental health, consider engaging in activities like mindfulness meditation, deep breathing exercises, or regular physical exercise. These practices can help enhance relaxation and promote overall well-being."
        },
        {
            "name": "energy_sleep",
            "summary": "Your ANS balance of 1 suggests a relatively balanced activity between your sympathetic nervous system (SNS) and parasympathetic nervous system (PNS). Good overall energy and sleep.",
            "tip": "You are doing a great job maintaining a balanced autonomic nervous system activity. Keep up the good work and continue prioritizing your energy and sleep for optimal well-being."
        },
        {
            "name": "mindfulness",
            "summary": "Your autonomic nervous system balance is relatively balanced, which is a good sign. However, your resonant breathing score indicates that there is room for improvement in synchronizing your breathing and heart rate variability. Your respiratory rate and heart rate are within normal ranges but slightly elevated, suggesting a moderate level of stress or lower conditioning.",
            "tip": "To improve your resonant breathing score and further synchronize your breathing and heart rate variability, try practicing slower and deeper breaths at a pace of around 6 breaths per minute. This can help promote relaxation and enhance the balance of your autonomic nervous system."
        }
    ]
}

400

{
    "detail": "Measurement with UUID not found!"
}

401

{
    "detail": "Missing or invalid authentication credentials."
}

404

{
    "detail": "Resource not found." // we currently do not provide feedback/tips for this scenario
}

406

{
    "detail": "The requested langauge is currently unavailable. Available languages: fr, en, nl."
}

422

{
    "detail": "This measurement did not process successfully. We cannot summarize this measurement!"
}

Results by patient ID

Use this endpoint to obtain results related to a patient (user) and/or performer.

Get History

GEThttps://engine.intelliprove.com/v1/patient/history

Get the history of results for one or more patients based on patient and/or performer reference.

Query parameters

patient-refstring	optional	Patient for which the health checks are retrieved.
performer-refstring	optional	Additional filter on performer reference.
startString	required	Date time string value in ISO 8601 format
pageInteger	required	Page of pagination
page_sizeInteger	optional	Number of items to return per page of pagination

Request

curl

curl --location 'https://engine.intelliprove.com/v1/patient/history?page=0&patient-ref=your-patient-ref&start=2022-03-27%2015%3A10%3A29&sort_by=timestamp&sort_desc=false' \
--header 'x-api-key: your-api-key'

Response

200

{
    "data": [
        {
            "timestamp_epoch": 1678100000,
            "timestamp": "2023-03-06T10:00:00+01:00",
            "heart_rate": 60,
            "respiratory_rate": 13,
            "heart_rate_variability": 48,
            "ans_balance": 1,
            "resonant_breathing_score": 30,
            "patient": "a84kgh404a",
            "performer": "pa7xb48209",
            "morning_readiness": null,
            "acute_mental_stress_score": 4,
            "mental_health_risk": 4
        },
        {
            "timestamp_epoch": 1678200030,
            "timestamp": "2023-04-06T10:00:00+01:00",
            "heart_rate": 57,
            "respiratory_rate": 12,
            "heart_rate_variability": 48,
            "ans_balance": 1,
            "resonant_breathing_score": 40,
            "patient": "a84kgh404a",
            "performer": "pa7xb48209",
            "morning_readiness": 3,
            "acute_mental_stress_score": 4,
            "mental_health_risk": 4
        }
    ],
    "pagination": {
        "page": 0,
        "page_size": 10,
        "sorted_by": "timestamp",
        "sorting_order": "asc",
        "sorting_options": [
            "timestamp",
            "performer"
        ]
    }
}

400

{
    "detail": "Please provide a patient reference."
}

401

{
    "detail": "Missing or invalid authentication credentials."
}

Update metadata

If required, you can update the metadata for a measurement after completing processing.

Update result metadata

PUThttps://engine.intelliprove.com/v1/results/update/{uuid}

Update the performer and/or patient refernences for a measurement.

Body parameters

performer-refstring	optional	An optional reference for the performer of the measurement
patient-refstring	optional	An optional reference for the patient on whom the measurement was performed

Request

curl

curl --location --globoff --request PUT 'https://engine.intelliprove.com/v1/results/update/{uuid}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"performer-ref":"string","patient-ref":"string"}'

Response

400

{
    "detail": "No results were found found for this UUID"
}

401

{
    "detail": "Missing or invalid authentication credentials."
}

403

{
    "detail": "You are not allowed to overwrite the performer for this measurement"
}