Skip to main content
POST
Get a URL that shows the lab results of one profile as a read-only page. Open the URL in a WebView of your app or in a browser tab. Call this endpoint from your server each time the user opens the results, and never cache the URL. Requires the embed and results_view scopes on a profile group of the profile. Aniva grants the embed scope on request. Without one of the two scopes, the request returns 403.
The URL works once and for 5 minutes. When it opens, the page starts a 60-minute session that only that page holds. Archive your API key to close every open page at once.

Request

Path parameters

string
required
Unique identifier (UUID) of the profile whose results the page shows.

Body

The body is optional. Without a body, the URL opens the biomarker list in the profile’s language.
string
Page language: en, bg, ca, cs, da, de, el, es, et, fi, fr, ga, hr, hu, is, it, lb, lt, lv, mt, nl, no, pl, pt, ro, ru, sk, sl, sr, sv, tr or uk. Default: the language of the profile.
object
The page that the URL opens. Default: { "name": "biomarkers" }. Any other name returns 400.
object
Limits every page to one lab report of the profile. Default: all reports of the profile. Send exactly one of the three ids. The list, the trend of a biomarker and the twin then show the results of that report only, and the page hides the appointment filter. The user cannot open another report with this URL.
object
The look of the page. The API adds it to the URL as search params.
You can also append the appearance params to a returned URL yourself, before the #token= fragment: theme=light|dark, primary=<hex> and logo=0. The page ignores an invalid value. The logo image always comes from your profile group, never from the URL.

Response

On success, the API returns 201 Created.
string
required
The page URL. The launch token is in the #token= fragment, so a browser never sends it to a server. Open it once.
string
required
ISO 8601 instant after which the URL cannot be opened.
The session is not bound to one page. Inside the embed, the user can move from the twin to a biomarker and between the list and the detail pages. The page shows only lab results: it does not show values that Aniva calculates, files, chat or settings.

Error responses