---
title: "Get EndUser statistics"
method: GET
path: "/api/end_users/statistics"
tags: ["EndUserCalculations"]
---

# Get EndUser statistics

`GET /api/end_users/statistics`

Get summarized statistics for a given EndUser

## Query parameters

- `end_user_id` string, nullable
- `end_user_heron_id` string, nullable
- `to_currency` 'GBP' | 'USD' | 'EUR' | 'CAD' | 'AUD' | 'null', nullable
- `from_date` string, date, nullable
- `to_date` string, date, nullable
- `date_granularity` 'day' | 'week' | 'month' | 'quarter' | 'year'
- `group_by` 'category' | 'merchant'
- `category_heron_ids` string[]
- `merchant_heron_ids` string[]
- `account_ids` string[]

## Response `200`

OK

- object
  - `statistics` EndUserStatsOutputSchema[]
    - `currency` string, nullable — ISO 4217 currency code
    - `dt` string — Date, impacted by input date granularity
    - `heron_id` string — Heron ID of either merchant or category, depending on what was specified in group_by
    - `label` string — Label of either merchant or category, depending on what was specified in group_by
    - `metrics` EndUserStatsOutputMetrics
      - `inflow` EndUserStatsOutputMetricsInstance
        - `amount` number — Aggregate amount of transactions
        - `avg_amount` number — Average value of transactions
        - `n` integer — Number of transactions
      - `net` EndUserStatsOutputMetricsInstance
        - `amount` number — Aggregate amount of transactions
        - `avg_amount` number — Average value of transactions
        - `n` integer — Number of transactions
      - `outflow` EndUserStatsOutputMetricsInstance
        - `amount` number — Aggregate amount of transactions
        - `avg_amount` number — Average value of transactions
        - `n` integer — Number of transactions

---

[API](https://skmtc.dev/herondata/apis/heron-data-api.md) · [All operations](https://skmtc.dev/herondata/apis/heron-data-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/herondata/heron-data-api/revisions/f2e441edece2/schema)