v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB

EndUserCalculations

Get EndUser forecasts

Get forecast amounts for a given EndUser and category

get/api/end_users/forecast

end_user_idstring nullable

Example:your_end_user_id

end_user_id for statistics; either end_user_id or end_user_heron_id is required

end_user_heron_idstring nullable

Example:eus_VzYMaabWpfbWi4dHKA4sRF

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

to_currency'GBP' | 'USD' | 'EUR' | 'CAD' | 'AUD' | 'null' nullable

Example:USD

ISO 4217 currency code to convert to

date_granularity'week' | 'month'

Example:month

Aggregate results over time, i.e., aggregate by week or by month

category_heron_idstring

Example:ctg_3x8yYAf2ENjKdLoeuVwGPc

Heron ID of category to be forecasted; either category_heron_id or category_label must be present

category_labelstring

Example:Revenue

Label of category to be forecasted; either category_heron_id or category_label must be present

from_datestring date nullable

Example:2022-01-01

The earliest transaction timestamp date to use in forecasting

to_datestring date nullable

Example:2022-01-31

The latest transaction timestamp date to use in forecasting

currencystring nullable

ISO 4217 currency code

datestring

Forecast date at specified date granularity

predictednumber

Predicted amount

predicted_lowernumber

Predict amount lower bound

predicted_uppernumber

Predicted amount upper bound

[
  {
    "currency": "USD",
    "date": "2026-07-23",
    "predicted": 42.42,
    "predicted_lower": 4.24,
    "predicted_upper": 420.42
  }
]