ProTips
Retrieve ProTips that InsideTracker makes available for a User.
ProTips
ProTips are timely, concise, evidence-based insights that reinforce recommended actions and explain the "why" behind them. InsideTracker is responsible for determining when a ProTip is available for a User based on biomarker profile, goals, behaviors, and available contextual data, such as recent activity or time since last engagement.
Use ProTips when your application needs short-form guidance that can appear in a feed, check-in experience, detail view, or contextual moment after InsideTracker has made a ProTip available.
Retrieve the latest ProTip when your application needs a current insight placement.
Retrieve filtered ProTips for a time window when your application needs history or backfill.
Retrieve a specific ProTip by ID when your experience opens a selected or saved detail view.
Where This Fits
Use ProTips after the User has health data and context that can support timely insight generation. Recommendations and Action Plan explain what actions apply to a User; ProTips help reinforce those actions at relevant moments.
Use the latest endpoint for current insight placements, the filtered list endpoint for history or backfill, and the by-ID endpoint when your application already has a specific ProTip ID from a previous response or stored application state.
Data Needed For This Output
| Data | Required? | How InsideTracker receives it | Why it matters | If it is missing |
|---|---|---|---|---|
| Linked InsideTracker customer record and customer-level token | Required | Create the linked customer record for the User and store the returned credentials. | ProTips are customer-level APIs. | Your application cannot retrieve User-specific ProTips. |
| Recommendation-generating health data | Required for most ProTips | Add Blood Result, Blood Result Upload, OCR, Lab Connect, supported wearable data, and profile/onboarding data when applicable. | ProTips are triggered from biomarker profile, goals, behaviors, and contextual data. | The User may have no ProTips for the requested time period or context. |
| Goals and recommendation context | Recommended | Recommendations and Action Plan workflows. | Helps ProTips reinforce actions that are relevant to the User's current goals or selected plan. | ProTips may be less targeted to the User's active priorities. |
| Recent activity or physiomarker context | Conditional | Connecting Wearable Devices and Retrieving Physio Data workflows. | Some ProTips can be tied to recent behaviors or contextual data. | Behavior-triggered ProTips may be unavailable. |
Workflow
API operations are shown with the operation name followed by the method and path.
- Make sure the User has a linked InsideTracker customer record and a valid customer-level token.
- Make sure the User has health data and context that can support ProTips.
- Retrieve the latest ProTip with Latest ProTip (
GET /myplan/customer/v3/pro-tips/latest) when you need a current insight placement. - Retrieve a time-windowed list with Filtered ProTips (
GET /myplan/customer/v3/pro-tips/list) when you need history, backfill, or recovery. - Retrieve a specific ProTip with ProTip by ID (
GET /myplan/customer/v3/pro-tips/{proTipId}) when your application has a saved or selected ProTip ID. - Handle empty states when no ProTip is available.
Endpoint Overview
| Use case | Endpoint | Notes |
|---|---|---|
| Latest ProTip | GET /myplan/customer/v3/pro-tips/latest | Use for current insight placements or fallback recovery. Returns an optional object. Use the response to determine whether a ProTip is present. |
| Filtered ProTips | GET /myplan/customer/v3/pro-tips/list | Use for history, backfill, or recovery. Supports optional startDateTime and endDateTime query parameters. If no date-time filters are provided, the API Reference describes the response as the User's ProTips for the last hour. |
| ProTip by ID | GET /myplan/customer/v3/pro-tips/{proTipId} | Use when your application has a specific ProTip ID, such as an ID from a previous ProTip response or saved application state. |
All ProTips endpoints require customer-level authentication.
ProTip Fields
| Field | Meaning | How to use it |
|---|---|---|
id | ProTip identifier. | Store when you need to open the same ProTip later. |
ruleId | Rule identifier associated with the ProTip. | Treat as API data unless InsideTracker gives you rule-level mapping guidance. |
title | Short ProTip title. | Use as the primary display heading. |
description | Main summary text. | Use as the concise ProTip body. |
bulbSection | Explanatory or insight-oriented section. | Use when your UI supports expanded detail. |
checkSection | Check or action-oriented section. | Use when your UI prompts the User to reflect, check progress, or take action. |
infoSection | Additional informational section. | Use in detail views when present. |
date | ProTip date. | Use for grouping or display when appropriate. |
sentTime | Timestamp associated with the ProTip delivery. | Use for ordering and recency. |
basedOn | Data points or drivers associated with the ProTip. | Use to explain why the ProTip is relevant. |
referenceUrl | Supporting reference URL, when present. | Preserve when your UI exposes supporting context. |
category | ProTip category returned by the API. | Treat as API data, not a fixed public taxonomy. |
type | ProTip type returned by the API. | Treat as API data, not a fixed public taxonomy. |
activity | Activity context, when present. | Use when the ProTip is tied to recent activity data. |
bloodResultId | Related blood result identifier, when present. | Use to connect the ProTip to the relevant blood result context. |
feedback | Existing feedback context, when present. | Display only if your experience supports that feedback state. |
Output Availability
| State | What it means | Application handling |
|---|---|---|
| ProTip present | The response includes a ProTip object for the requested latest, filtered, or ID lookup. | Render the ProTip using the fields your experience supports. |
| No latest ProTip | The latest endpoint can return an optional response indicating that no ProTip is present. | Show an empty state or skip the ProTip placement. |
| Empty filtered list | No ProTips were returned for the requested time window. | Do not treat this as an error; show an empty history state or omit the feed section. |
| ProTip not found | A requested ProTip ID is unavailable for the User. | Handle as a missing or stale reference. |
Best Practices
Implementation guidance
- Use the latest endpoint for current insight placements and the filtered endpoint for history, backfill, or recovery.
- Use the by-ID endpoint when a User opens a selected ProTip, saved ProTip, or detail view backed by a known ProTip ID.
- Do not hard-code ProTip categories, types, or
basedOnvalues as a fixed taxonomy. - Preserve supporting reference URLs when your UI exposes evidence context.
- Keep ProTips distinct from Recommendations and Action Plan: ProTips reinforce and contextualize action, while Recommendations and Action Plan drive selection, scheduling, and adherence tracking.
- Handle no-content responses as a normal state.
Implementation Checklist
- You have a customer-level access token for the User.
- The User has health data and context that can support ProTips.
- Your application retrieves the latest ProTip when it needs a current insight placement.
- Your application handles latest, filtered-list, and by-ID retrieval as separate use cases.
- Your UI can render optional sections without requiring every field.
- Your UI handles no-ProTip and empty-list states.
- Your data model stores
idwhen your experience deep-links or reopens ProTips.
Related API Reference
GET /myplan/customer/v3/pro-tips/{proTipId}GET /myplan/customer/v3/pro-tips/latestGET /myplan/customer/v3/pro-tips/list
Related Topics
- Recommendations
- Action Plan
- Connecting Wearable Devices
- Retrieving Physio Data
Updated 27 days ago