curl --request GET \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/recurring_transactions_report \
--header 'x-api-key: <api-key>'
[
{
"avg_amount": {
"amount": "1234.56",
"currency": "USD"
},
"avg_confidence": 123,
"counterparty": "<string>",
"frequency": "not_enough_data",
"merchant_name": "<string>",
"transactions": [
{
"amount": {
"amount": "1234.56",
"currency": "USD"
},
"category_confidence": 123,
"category_heron_id": "<string>",
"category_label": "<string>",
"counterparty": "<string>",
"description": "<string>",
"heron_id": "<string>",
"merchant_heron_id": "<string>",
"merchant_name": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
]
}
]
Get a report of recurring transactions grouped by merchant or counterparty for an end user
curl --request GET \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/recurring_transactions_report \
--header 'x-api-key: <api-key>'
[
{
"avg_amount": {
"amount": "1234.56",
"currency": "USD"
},
"avg_confidence": 123,
"counterparty": "<string>",
"frequency": "not_enough_data",
"merchant_name": "<string>",
"transactions": [
{
"amount": {
"amount": "1234.56",
"currency": "USD"
},
"category_confidence": 123,
"category_heron_id": "<string>",
"category_label": "<string>",
"counterparty": "<string>",
"description": "<string>",
"heron_id": "<string>",
"merchant_heron_id": "<string>",
"merchant_name": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
]
}
]
Account ids to include in the report, if not provided, all accounts are included
OK
The response is of type object[]
.
Was this page helpful?