curl --request GET \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/benchmarks \
--header 'x-api-key: <api-key>'{
"benchmarks": [
{
"date_range": "last_180_days",
"label": "unique_transactions",
"percentile": 0.75,
"rank": 22,
"sample_size": 42,
"scope": "user"
}
]
}Get the benchmarks for each metric for an end user
curl --request GET \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/benchmarks \
--header 'x-api-key: <api-key>'{
"benchmarks": [
{
"date_range": "last_180_days",
"label": "unique_transactions",
"percentile": 0.75,
"rank": 22,
"sample_size": 42,
"scope": "user"
}
]
}OK
Show child attributes
latest, last_30_days, last_90_days, last_120_days, last_180_days, last_365_days, next_30_days, next_60_days, next_90_days, next_180_days, last_1_calendar_months, last_3_calendar_months, last_4_calendar_months, last_6_calendar_months, last_12_calendar_months, last_15_calendar_months, last_24_calendar_months, last_1_full_calendar_months, last_2_full_calendar_months, last_3_full_calendar_months, last_6_full_calendar_months, last_12_full_calendar_months, last_60_days, last_45_days, last_2_calendar_months "last_180_days"
Metric label, slugified
"unique_transactions"
The implied percentile based on ranking and sample size
0.75
Ranking of metric relative to datapoints. 1 is best
22
The number of datapoints to compare to
42
What end users are included in metric comparisons
user, heron "user"
Was this page helpful?