GET
/
api
/
end_users
/
statistics

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

to_date
string | null

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

from_date
string | null

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

category_heron_ids
string[]

Filter by specific categories

to_currency
enum<string> | null

ISO 4217 currency code to convert to

Available options:
GBP,
USD,
EUR
end_user_heron_id
string | null

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

group_by
enum<string>
default:
category

Pivot results by merchant or by category

Available options:
category,
merchant
end_user_id
string | null

end_user_id for statistics; either end_user_id or end_user_heron_id is required

date_granularity
enum<string>
default:
month

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

Available options:
day,
week,
month,
quarter,
year
merchant_heron_ids
string[]

Filter by specific merchants

Response

200 - application/json
statistics
object[]