GET
/
api
/
end_users
/
statistics
curl --request GET \
  --url https://app.herondata.io/api/end_users/statistics \
  --header 'x-api-key: <api-key>'
{
  "statistics": [
    {
      "currency": "USD",
      "dt": "2025-06-19",
      "heron_id": "mrc_bWansVH46r28ZWsQpokSW5",
      "label": "Revenue",
      "metrics": {
        "inflow": {
          "amount": 42.42,
          "avg_amount": 1.01,
          "n": 42
        },
        "net": {
          "amount": 42.42,
          "avg_amount": 1.01,
          "n": 42
        },
        "outflow": {
          "amount": 42.42,
          "avg_amount": 1.01,
          "n": 42
        }
      }
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
end_user_heron_id
string | null

Heron-generated id for end user; either end_user_id or end_user_heron_id is required

Example:

"eus_9wMk3F9mPWs62cwofgxyKX"

​
from_date
string | null

Filter for transactions with timestamp after the input value (as date)

Example:

"2025-06-19"

​
end_user_id
string | null

end_user_id for statistics; either end_user_id or end_user_heron_id is required

Example:

"your_end_user_id"

​
merchant_heron_ids
string[]

Filter by specific merchants

Example:
[
  "mrc_jAYM6xqc3wUjpAZctiCj3r",
  "mrc_GWjSVETt3UFmwCR5CeKu28"
]
​
group_by
enum<string>
default:category

Pivot results by merchant or by category

Available options:
category,
merchant
Example:

"category"

​
date_granularity
enum<string>
default:month

Aggregate results over time, e.g., by week or by quarter

Available options:
day,
week,
month,
quarter,
year
Example:

"month"

​
to_currency
enum<string> | null

ISO 4217 currency code to convert to

Available options:
GBP,
USD,
EUR
Example:

"USD"

​
category_heron_ids
string[]

Filter by specific categories

Example:
[
  "ctg_Tm9qYwno66QWEa6uBnMuSF",
  "ctg_3Zy4Kyrzng3dfPPYr2uCVa"
]
​
to_date
string | null

Filter for transactions with timestamp before the input value (as date)

Example:

"2025-06-18"

Response

200 - application/json

OK

The response is of type object.