Skip to main content
GET
/
api
/
end_users
/
{end_user_id_or_heron_id}
/
heron_score
Get EndUser Heron Score (beta)
curl --request GET \
  --url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/heron_score \
  --header 'x-api-key: <api-key>'
{
  "data_quality_issues": [],
  "feature_groups_contributions": {},
  "predicted_at": "2023-11-07T05:31:56Z",
  "reference_timestamp": "2023-11-07T05:31:56Z",
  "value": 123
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
end_user_id_or_heron_id
string
required

Query Parameters

​
min_category_confidence
number | null

Minimum company categorisation confidence to calculate Heron Score

Example:

0.8

​
date
string<date> | null

Cut-off date to consider transactions to for calculating heron score (inclusive)

Example:

"2023-01-19"

Response

200 - application/json

OK

​
data_quality_issues
enum<string>[]

A list of data quality issues that may have impacted the score

Available options:
transactions_without_timestamps,
date_range_too_low,
confidence_too_low,
ctg_coverage_too_low,
data_volume_too_low,
data_not_fresh
​
feature_groups_contributions
object
​
predicted_at
string<date-time>

When the Heron Score was predicted

​
reference_timestamp
string<date-time>

When the Heron Score was calculated for; by default the last transaction timestamp for the company

​
status
enum<string>
Available options:
not_available,
partially_available,
available
​
value
integer

The Heron Score value