curl --request GET \
--url https://sandbox.rx.tera.health/v1/reports/brand \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandbox.rx.tera.health/v1/reports/brand', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://sandbox.rx.tera.health/v1/reports/brand"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"period": {
"from": "2026-10-01",
"to": "2026-10-31"
},
"generated_at": "2026-11-01T06:00:00Z",
"min_group_size": 10,
"totals": {
"active_enrollments": 214,
"new_enrollments": 61,
"cancelled_enrollments": 12,
"engaged_last_7_days": 168,
"median_weight_change_kg": -4.6,
"protein_target_days_pct": 0.57,
"flags_raised": 18,
"flags_acknowledged_on_time_pct": 0.94,
"ai_coach_thumbs_up_pct": 0.88,
"retention_90_day_pct": null,
"median_hours_to_first_protocol": 26.5
},
"plans": [
{
"plan_code": "ai_health_fitness",
"metrics": {
"active_enrollments": 131,
"new_enrollments": 35,
"cancelled_enrollments": null,
"engaged_last_7_days": 109,
"median_weight_change_kg": -5.1,
"protein_target_days_pct": 0.63,
"flags_raised": 11,
"flags_acknowledged_on_time_pct": 1,
"ai_coach_thumbs_up_pct": 0.9,
"retention_90_day_pct": null,
"median_hours_to_first_protocol": 31
}
},
{
"plan_code": "ai_only",
"metrics": {
"active_enrollments": 83,
"new_enrollments": 26,
"cancelled_enrollments": null,
"engaged_last_7_days": 59,
"median_weight_change_kg": -3.8,
"protein_target_days_pct": 0.48,
"flags_raised": null,
"flags_acknowledged_on_time_pct": null,
"ai_coach_thumbs_up_pct": 0.86,
"retention_90_day_pct": null,
"median_hours_to_first_protocol": 0.1
}
}
]
}Get the brand report
Enrollment counts, engagement and outcomes for a period, in total and per plan. Aggregates only, never
patient-level values; any metric whose group has fewer than 10 patients is null. Ask for
Accept: application/pdf for the same report as a PDF. Periods can be up to 366 days.
Error code: period_too_long (422).
Scope: reports:read.
curl --request GET \
--url https://sandbox.rx.tera.health/v1/reports/brand \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandbox.rx.tera.health/v1/reports/brand', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://sandbox.rx.tera.health/v1/reports/brand"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"period": {
"from": "2026-10-01",
"to": "2026-10-31"
},
"generated_at": "2026-11-01T06:00:00Z",
"min_group_size": 10,
"totals": {
"active_enrollments": 214,
"new_enrollments": 61,
"cancelled_enrollments": 12,
"engaged_last_7_days": 168,
"median_weight_change_kg": -4.6,
"protein_target_days_pct": 0.57,
"flags_raised": 18,
"flags_acknowledged_on_time_pct": 0.94,
"ai_coach_thumbs_up_pct": 0.88,
"retention_90_day_pct": null,
"median_hours_to_first_protocol": 26.5
},
"plans": [
{
"plan_code": "ai_health_fitness",
"metrics": {
"active_enrollments": 131,
"new_enrollments": 35,
"cancelled_enrollments": null,
"engaged_last_7_days": 109,
"median_weight_change_kg": -5.1,
"protein_target_days_pct": 0.63,
"flags_raised": 11,
"flags_acknowledged_on_time_pct": 1,
"ai_coach_thumbs_up_pct": 0.9,
"retention_90_day_pct": null,
"median_hours_to_first_protocol": 31
}
},
{
"plan_code": "ai_only",
"metrics": {
"active_enrollments": 83,
"new_enrollments": 26,
"cancelled_enrollments": null,
"engaged_last_7_days": 59,
"median_weight_change_kg": -3.8,
"protein_target_days_pct": 0.48,
"flags_raised": null,
"flags_acknowledged_on_time_pct": null,
"ai_coach_thumbs_up_pct": 0.86,
"retention_90_day_pct": null,
"median_hours_to_first_protocol": 0.1
}
}
]
}Authorizations
A brand's server, one OAuth client per brand and environment. Get a token with the
client_credentials grant and send it as Authorization: Bearer <token>. Tokens last 1 hour.
A brand server reads status and ids only; it never reads clinical content. A platform partner holds one
client for all its brands and gets one token per brand, naming it with tenant_id.
Query Parameters
Only this plan.
ai_only: the AI Coach only. Escalations go to the brand's prescriber as clinical flags.ai_health_fitness: the AI Coach plus a health coach (nutrition) and a fitness coach.
ai_only, ai_health_fitness "ai_health_fitness"
Response
The report.
Show child attributes
Show child attributes
ISO 8601 in UTC.
"2026-10-26T14:05:00Z"
Groups smaller than this are suppressed.
Aggregates only, no patient-level values. Each metric is suppressed on its own when its group is under 10 patients.
Show child attributes
Show child attributes
Show child attributes
Show child attributes