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 overview docid\ qghldn2mla8w9rpkeigwn 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 docid\ fwrilxhap81oojwmwf3tr , 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 docid\ f86cembkuj kwr60rtrev 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 overview docid\ fwrilxhap81oojwmwf3tr 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 management api docid ez tag25qim8zucoubyi 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 docid\ nhmyw3igywbv wbatholb more information about the actual biomarkers we measure can be found on the following page insights & biomarkers docid 3pruszmjt22mzxvkufpwd use the below endpoint to request the results of a previously performed health check note that we recommend listening to events, as described in message events docid\ nhmyw3igywbv wbatholb , 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 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 docid 3ubjuaxicjgeicclkq13z , 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 the below endpoint allows you to fetch the summary and tips corresponding to each bucket results by patient id use this endpoint to obtain results related to a patient (user) and/or performer update metadata if required, you can update the metadata for a measurement after completing processing