Skip to main content
GET
Get EndUser statistics

Authorizations

x-api-key
string
header
required

Query Parameters

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"

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_NYxZCEcov3u8sFnAZ7EvF2"

to_currency
enum<string> | null

ISO 4217 currency code to convert to

Available options:
GBP,
USD,
EUR,
CAD,
AUD,
null
Example:

"USD"

from_date
string<date> | null

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

Example:

"2026-07-24"

to_date
string<date> | null

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

Example:

"2026-07-23"

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"

group_by
enum<string>
default:category

Pivot results by merchant or by category

Available options:
category,
merchant
Example:

"category"

category_heron_ids
string[]

Filter by specific categories

Example:
merchant_heron_ids
string[]

Filter by specific merchants

Example:
account_ids
string[]

Filter by specific account reference IDs

Example:

Response

200 - application/json

OK

statistics
object[]