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-06-09T21:52:59.486815",
"date_range": "last_180_days",
"group": "data_quality_datasource",
"heron_id": "rul_gq6fe6CP96bfyYJmeEY4Bv",
"last_updated": "2025-07-21T21:52:59.486846",
"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"
}
}
]
}
Get scorecard metrics and rule violations for a user
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-06-09T21:52:59.486815",
"date_range": "last_180_days",
"group": "data_quality_datasource",
"heron_id": "rul_gq6fe6CP96bfyYJmeEY4Bv",
"last_updated": "2025-07-21T21:52:59.486846",
"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"
}
}
]
}
Cut-off date to consider transactions to for calculating scorecard (inclusive)
"2023-01-19"
Qualitative description for date to calculate scorecard
end_user_created
, end_user_last_updated
, last_transaction
, end_user_last_enriched
, last_data_source_end_date_or_transaction_timestamp
, custom_date
"end_user_created"
OK
The response is of type object
.
Was this page helpful?