Get EndUser forecasts

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

to_currency

enum<string> | null

ISO 4217 currency code to convert to

Available options:

GBP,

USD,

EUR,

CAD,

AUD,

null

Example:

"USD"

date_granularity

enum<string>

default:month

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

Available options:

week,

month

Example:

"month"

category_heron_id

string

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

Example:

"ctg_5x7p5GqJX7XdbPBE6fBi3S"

category_label

string

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

Example:

"Revenue"

from_date

string<date> | null

The earliest transaction timestamp date to use in forecasting

Example:

"2022-01-01"

to_date

string<date> | null

The latest transaction timestamp date to use in forecasting

Example:

"2022-01-31"

Response

200 - application/json

currency

string | null

ISO 4217 currency code

Required string length: 3

Example:

"USD"

date

string

Forecast date at specified date granularity

Example:

"2026-06-04"

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