Sign in

v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB
EndUserCalculations

Get EndUser scorecard

Get scorecard metrics and rule violations for a user

get/api/end_users/{end_user_id_or_heron_id}/scorecard

Path parameters

end_user_id_or_heron_idstring required

Query parameters

datestring date nullable
Example:2023-01-19

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

named_date'end_user_created' | 'end_user_last_updated' | 'last_transaction' | 'end_user_last_enriched' | 'last_data_source_end_date_or_transaction_timestamp' | 'custom_date' | 'null' nullable
Example:end_user_created

Qualitative description for date to calculate scorecard

Response

OK

Example response

{
  "metrics": [
    {
      "context": "higher_is_better",
      "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": 42.42
    }
  ],
  "rule_violations": [
    {
      "metric": {
        "context": "higher_is_better",
        "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": 42.42
      },
      "rule": {
        "condition": "equal",
        "created": "2026-06-11T19:53:57.382026",
        "date_range": "last_180_days",
        "group": "data_quality_datasource",
        "heron_id": "rul_8XVZYCL7hsxMRTqvEaiYw2",
        "last_updated": "2026-07-23T19:53:57.382081",
        "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"
      }
    }
  ]
}