GET
/
api
/
end_users
/
forecast

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

The latest transaction timestamp date to use in forecasting

category_heron_id
string

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

from_date
string | null

The earliest transaction timestamp date to use in forecasting

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

category_label
string

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

date_granularity
enum<string>
default:
month

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

Available options:
week,
month
end_user_id
string | null

end_user_id for statistics; either end_user_id or end_user_heron_id is required

Response

200 - application/json
currency
string | null

ISO 4217 currency code

Required string length: 3
date
string

Forecast date at specified date granularity

predicted
number

Predicted amount

predicted_lower
number

Predict amount lower bound

predicted_upper
number

Predicted amount upper bound