Fetch and visualise insights

introduction intelliprove offers multiple options for designing user experiences focused on health monitoring and visualising insights, making it easy for users to comprehend and interact with their health data head to our overview docid\ d z1x fglae 0r7hcnuth to learn more this guide will show you how to design a user flow and display the results according to your use case, using our rest api, widgets or plug and play results dashboard flow when a user performs a face scan, biomarkers docid\ buhj nt45fuxcpges0qph are calculated and linked to this face scan each face scan therefore has a unique id the information from multiple face scans is used to calculate metrics docid\ yeqwskx81eju z8n3djhy , which are parameters that provide a deeper understanding and are based on long term assessment you will be able to use the user's id and/or the face scan id's to fetch biomarkers and metrics prerequisites make sure to go through the first four steps of the getting started to understand how to register users and set up an initial integration of the plug in in your website or app initial integration docid\ qghldn2mla8w9rpkeigwn proceeding after the face scan when a user completes a face scan, your platform should respond appropriately for example, you could transition to a new page displaying the scan results or your health dashboard to determine when to proceed, listen for messages sent by the plug in for instance, the dismiss message accompanied by the facescansuccessful message signals that the face scan was completed successfully refer to our message events documentation for more details about these events message events docid\ kz6xsnd6v4g8efcgd02ib it's important to note that you might also receive a userfinished event if the user ends the face scan without successfully completing it, for example, due to unfavorable conditions we recommend accounting for this in your user journey design, for example by adapting the content accordingly fetching and displaying health insights api the api is ideal to fetch raw results, which you can use to link your own custom logic, create custom visualizations or use as input to send alerts or guide the user journey you can use the api to fetch both biomarkers and metrics biomarkers to fetch the biomarkers from a specific face scan, you'll need the unique face scan id o r the user's id rest api docid\ biupvixvhltbukklr2ati rest api docid\ biupvixvhltbukklr2ati how do i obtain the face scan id? you can obtain the face scan id by listening to events generated by the plug in t he facescansuccessful event is generated when the face scan is completed successfully and signals that the results are ready the event json message contains the face scan id our message events documentation contains detailed information about the different types of message events that are sent by the plug in message events docid\ kz6xsnd6v4g8efcgd02ib metrics to fetch the user's health metrics, you can use your own external user id , used when you created the user the ' user health profiles ' endpoints allow you to fetch the metrics per health profile, as well as a feedback and tip message for every health profile rest api docid\ biupvixvhltbukklr2ati widgets biomarkers the biomarker widget displays the value of a specific biomarker, calculated during one of the face scans the user performed you will need the face scan id (see above on how to obtain it) biomarker widget docid 3twbyjpm7m9a7dftx0xng metrics the metric widget can be used to display the value of a specific metric metric widget docid 6b 0cnu5cm5uyzx4jjbxp plug and play results dashboard planned for release this product is being released in july 2025 we will notify you once this is available the plug and play results dashboard can simply be integrated using an iframe you will be able to retrieve the url for the results screen by calling a dedicated api endpoint and providing the user's id for instructions on how to embed the results dashboard using the obtained url, refer to embed in web app docid zgiigvbl mnr dvhvp46 this is the same process used to embed the plug in for performing face scans