Skip to content

Get Heatmap

GET
/api/v1/admin/activation/heatmap
curl --request GET \
--url https://api.ultimateteam.ai/api/v1/admin/activation/heatmap \
--header 'X-API-Key: <X-API-Key>'

Return 12-cohort retention heat map + median TTFA.

Successful Response

Media typeapplication/json
HeatmapPayload
object
cohorts
required
Cohorts
Array<object>
HeatmapCell
object
cohort_age_days
required
Cohort Age Days
integer
cohort_label
required
Cohort Label
string
cohort_size
required
Cohort Size
integer
d1_pct
required
Any of:
number
d30_pct
required
Any of:
number
d7_pct
required
Any of:
number
generated_at
required
Generated At
string
median_ttfa_seconds
required
Any of:
number
Examplegenerated
{
"cohorts": [
{
"cohort_age_days": 1,
"cohort_label": "example",
"cohort_size": 1,
"d1_pct": 1,
"d30_pct": 1,
"d7_pct": 1
}
],
"generated_at": "example",
"median_ttfa_seconds": 1
}