Skip to main content
GET
/
api
/
end_users
/
{end_user_id_or_heron_id}
/
merchant_summary
Get EndUser merchant summary
curl --request GET \
  --url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/merchant_summary \
  --header 'x-api-key: <api-key>'
{
  "by_merchant_summary": [
    {
      "group": "<string>",
      "heron_id": "<string>",
      "inflow_metrics": {
        "amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "changed_in_last_90_days": true,
        "count": 123,
        "duration_days": 123,
        "estimated_monthly_amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "frequency": "not_enough_data",
        "is_active": true,
        "max_amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "max_timestamp": "2023-11-07T05:31:56Z",
        "mean_amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "mean_interval_days": 123,
        "median_amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "min_amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "min_timestamp": "2023-11-07T05:31:56Z",
        "mode_amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "mode_interval_days": 123,
        "std_dev_amount": {
          "amount": "1234.56",
          "currency": "USD"
        }
      },
      "name": "<string>",
      "net_metrics": {
        "amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "changed_in_last_90_days": true,
        "count": 123,
        "duration_days": 123,
        "estimated_monthly_amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "frequency": "not_enough_data",
        "is_active": true,
        "max_amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "max_timestamp": "2023-11-07T05:31:56Z",
        "mean_amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "mean_interval_days": 123,
        "median_amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "min_amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "min_timestamp": "2023-11-07T05:31:56Z",
        "mode_amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "mode_interval_days": 123,
        "std_dev_amount": {
          "amount": "1234.56",
          "currency": "USD"
        }
      },
      "outflow_metrics": {
        "amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "changed_in_last_90_days": true,
        "count": 123,
        "duration_days": 123,
        "estimated_monthly_amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "frequency": "not_enough_data",
        "is_active": true,
        "max_amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "max_timestamp": "2023-11-07T05:31:56Z",
        "mean_amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "mean_interval_days": 123,
        "median_amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "min_amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "min_timestamp": "2023-11-07T05:31:56Z",
        "mode_amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "mode_interval_days": 123,
        "std_dev_amount": {
          "amount": "1234.56",
          "currency": "USD"
        }
      },
      "transactions": [
        {
          "amount": {
            "amount": "1234.56",
            "currency": "USD"
          },
          "category": {
            "heron_id": "<string>",
            "label": "<string>"
          },
          "description": "<string>",
          "heron_id": "<string>",
          "timestamp": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
end_user_id_or_heron_id
string
required

Query Parameters

​
group_by_counterparty_txn_clusters
boolean
default:false

Whether to group by counterparty transaction clusters

​
analytics_group
(enum<string> | null)[] | null
Minimum array length: 1

The category analytics group

Available options:
revenue,
cost_of_goods_sold,
operational_expenses,
tax_expenses,
intra_company,
debt,
equity,
other_income,
special_items,
other,
Example:

"debt"

​
category_label_or_heron_id
string[] | null
Minimum array length: 1
​
account_ids
string[] | null

Account ids to include in the summary, if not provided, all accounts are included

Response

200 - application/json

OK

​
by_merchant_summary
object[]