Skip to main content
GET
/
api
/
end_users
/
forecast
Get EndUser forecasts
curl --request GET \
  --url https://app.herondata.io/api/end_users/forecast \
  --header 'x-api-key: <api-key>'
[
  {
    "currency": "USD",
    "date": "2025-10-22",
    "predicted": 42.42,
    "predicted_lower": 4.24,
    "predicted_upper": 420.42
  }
]

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
date_granularity
enum<string>
default:month

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

Available options:
week,
month
Example:

"month"

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

​
to_date
string<date> | null

The latest transaction timestamp date to use in forecasting

Example:

"2022-01-31"

​
from_date
string<date> | null

The earliest transaction timestamp date to use in forecasting

Example:

"2022-01-01"

​
category_label
string

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

Example:

"Revenue"

​
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_9wK2Cs9mNSzowptGpB2aUB"

​
to_currency
enum<string> | null

ISO 4217 currency code to convert to

Available options:
GBP,
USD,
EUR
Example:

"USD"

​
category_heron_id
string

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

Example:

"ctg_h5MRX8bNFLgatxRVJjxnS3"

Response

200 - application/json

OK

​
currency
string | null

ISO 4217 currency code

Required string length: 3
Example:

"USD"

​
date
string

Forecast date at specified date granularity

Example:

"2025-10-22"

​
predicted
number

Predicted amount

Example:

42.42

​
predicted_lower
number

Predict amount lower bound

Example:

4.24

​
predicted_upper
number

Predicted amount upper bound

Example:

420.42