GET
/
api
/
end_users
/
{end_user_id_or_heron_id}
/
scorecard
Get EndUser scorecard
curl --request GET \
  --url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/scorecard \
  --header 'x-api-key: <api-key>'
{
  "metrics": [
    {
      "context": "higher_is_better",
      "currency": "<string>",
      "date_range": "last_180_days",
      "description": "The number of unique transactions with a timestamp",
      "group": "data_quality",
      "label": "unique_transactions",
      "status": "not_available",
      "unit": "n",
      "value": "<any>"
    }
  ],
  "rule_violations": [
    {
      "metric": {
        "context": "higher_is_better",
        "currency": "<string>",
        "date_range": "last_180_days",
        "description": "The number of unique transactions with a timestamp",
        "group": "data_quality",
        "label": "unique_transactions",
        "status": "not_available",
        "unit": "n",
        "value": "<any>"
      },
      "rule": {
        "condition": "equal",
        "created": "2025-05-08T18:49:45.597995",
        "date_range": "last_180_days",
        "group": "data_quality_datasource",
        "heron_id": "rul_BWFjePHKfSCdrRYxkCNa5v",
        "last_updated": "2025-06-19T18:49:45.598030",
        "metric_label": "unique_transactions",
        "name": "notify_if_debt_investment_count_gt_0_last_180d",
        "selector": {
          "is_portfolio": true
        },
        "value": 42.42,
        "value_str": "mrc_12345678ijwdd321d921"
      }
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
end_user_id_or_heron_id
string
required

Query Parameters

​
date
string | null

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

Example:

"2023-01-19"

​
named_date
enum<string> | null

Qualitative description for date to calculate scorecard

Available options:
end_user_created,
end_user_last_updated,
last_transaction,
end_user_last_enriched,
last_data_source_end_date_or_transaction_timestamp,
custom_date
Example:

"end_user_created"

Response

200 - application/json

OK

The response is of type object.