v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB

EndUserCalculations

Get EndUser Heron Score (beta)

Get Heron Score for end user with a breakdown of the feature group contributions which resulted in the score. The score is calculated for the day of last transaction. This is a beta feature and is subject to change.

get/api/end_users/{end_user_id_or_heron_id}/heron_score

Path parameters

end_user_id_or_heron_idstring required

Query parameters

min_category_confidencenumber nullable

Example:0.8

Minimum company categorisation confidence to calculate Heron Score

datestring date nullable

Example:2023-01-19

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

Response

data_quality_issuesstring[]

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

feature_groups_contributionsobject

predicted_atstring date-time

When the Heron Score was predicted

reference_timestampstring date-time

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

status'not_available' | 'partially_available' | 'available'

valueinteger

The Heron Score value