Supporting Research
Retrieve educational biomarker and category content that helps Users understand InsideTracker health data.
Supporting Research
Supporting Research provides educational content for blood biomarkers and biomarker categories. Use it when your application needs more than marker names, units, ranges, or scores and wants to help Users understand what a biomarker or category represents.
Retrieve descriptions and related content for specific blood biomarkers.
Retrieve educational content for broader biomarker categories.
Use related physiomarker text to connect blood data to broader health context.
Where This Fits
Supporting Research is part of biomarker enrichment. Use it after your application already knows the biomarker abbreviation or category abbreviation it wants to explain.
This page is for educational content. Use Biomarker Reference Data for marker IDs, names, units, synonyms, precision, and input bounds. Use Category Scores for personalized category score states and score display.
What This Supports
| Use case | Endpoint | Notes |
|---|---|---|
| Blood biomarker detail pages | GET /api/public/blood/markers/{markerAbbr}/extra-information | Use when you want explanatory content for a specific biomarker. |
| Biomarker category detail pages | GET /api/public/marker-categories/{categoryAbbr}/extra-information | Use when you want explanatory content for a category such as METABOLISM. |
| Learn-more modules | Either endpoint, depending on context | Display descriptions first and treat articles or videos as optional supporting content. |
| Blood-to-physio context | Blood biomarker endpoint | Use physioRelatedTexts when you want to explain how a biomarker relates to physiomarkers. |
Before You Begin
| Requirement | Why you need it |
|---|---|
markerAbbr or categoryAbbr | Required path value for the endpoint you call. |
| Reference data | Use Biomarker Reference Data or marker category reference data to confirm abbreviations and display names. |
| Content handling | Article, video, and related-text content may not be present for every marker or category. |
Blood Biomarker Content
GET /api/public/blood/markers/{markerAbbr}/extra-informationUse this endpoint for biomarker-level education, such as a biomarker detail page or tooltip.
| Parameter | Required | Description |
|---|---|---|
markerAbbr | Yes | Blood marker abbreviation, such as Glu. |
Blood biomarker response fields
| Field | Description |
|---|---|
name | Biomarker display name. |
abbr | Biomarker abbreviation. |
description | Educational biomarker description. |
video | Optional video content and preview assets. |
articles | Related articles with metadata, preview image, author, URL, and creation date. |
physioRelatedTexts | Text connecting the blood biomarker to related physiomarkers. |
Category Content
GET /api/public/marker-categories/{categoryAbbr}/extra-informationUse this endpoint for category-level education, such as a category detail page or a learn-more panel connected to Category Scores.
| Parameter | Required | Description |
|---|---|---|
categoryAbbr | Yes | Biomarker category abbreviation, such as METABOLISM. |
Category response fields
| Field | Description |
|---|---|
name | Category display name. |
description | Educational category description. |
video | Optional video content and preview assets. |
articles | Related articles with metadata, preview image, author, URL, and creation date. |
Implementation Pattern
- Start with a biomarker abbreviation or category abbreviation from reference data, a result, or an output.
- Retrieve supporting content from the marker or category extra-information endpoint.
- Display the returned description when present.
- Display articles, videos, and related physiomarker text only when those arrays are populated.
- Keep general educational content visually distinct from personalized result values, ranges, scores, and recommendations.
- Refresh cached content on a regular cadence because article and video references may change.
Best Practices
- Use Biomarker Reference Data to confirm
markerAbbrvalues before requesting marker-level content. - Use marker category reference data to confirm
categoryAbbrvalues before requesting category-level content. - Treat article and video URLs as content references that may change over time.
- Design the UI to handle descriptions without articles or videos.
- Handle missing content gracefully, including
404responses for markers or categories that do not have extra information. - Do not use supporting content as a substitute for personalized outputs such as Optimal Zones, Category Scores, Recommendations, or Inner Age.
Related API Reference
GET /api/public/blood/markers/{markerAbbr}/extra-informationGET /api/public/marker-categories/{categoryAbbr}/extra-informationGET /api/public/references/blood-markersGET /api/public/references/marker-categories- Related topic: Biomarker Reference Data
- Related topic: Category Scores
Updated about 1 month ago