shorttermforecasthistory#

This function returns monthly gas production backcasts for well APIs.

Backcasts are historical production forecasts. A backcast in this context may be described as:

  • A historical production forecast meant to replicate a forecast model on a specified historical date.

  • A forecast that only uses data that was available on or before the specified date. For example, if a backcast is from November 11, 2021, it will only use data which was available up until November 11, 2021.

Backcasts give an accurate representation of how our forecast performed on that day.

It sends a post request to the Hyperion V4 shorttermforecasthistory endpoint.

In the Formula Builder, select Hyperion 4.0, then choose the shorttermforecasthistory function from the Enter Function dropdown. Next, select the required fields and click Insert to automatically add the formula to Excel.

shorttermforecasthistory function selected in SynMax Formula Builder UI

Syntax#

=SMXH4.shorttermforecasthistory(aggregate_by,region_natgas,state_code,sub_region_natgas,operator,date_forecast_run,date_prod_min,date_prod_max,well_id)

Arguments#

Parameter

Description

Example

aggregate_by

Specifies a parameter by which to aggregate data.

"date"

date_forecast_run

Date of nearest forecast (unsynced). (format: “YYYY-MM-DD”)

"2025-11-14"

date_prod_max

A date in MM/DD/YYYY format

"12/31/2023"

date_prod_min

A date in MM/DD/YYYY format

"1/6/2023"

operator

Limit search by the name of the operator whose wells to retrieve.

"A WILLIAMS OIL"

region_natgas

Region divisions based on natural gas production profiles.

"gulf"

state_code

Limit search by the state code where the wells are located.

"CO"

sub_region_natgas

Subregion divisions based on natural gas production profiles.

"S LA"

well_id

A well identifier

"4900552885"

Note

Performance considerations: This function may take some time to retrieve and organize large amounts of data. For best performance, it is recommended to limit the number of input parameters and retrieve only the data needed for analysis.

Note

No Data: Output data will return “No Data” when input data is invalid or does not exist.

Output data will return as "null" when input data is invalid or does not exist

Examples#

  1. Get short-term forecast history for a specific date_forecast_run aggregate by date_prod:

=SMXH4.shorttermforecasthistory("date_prod","","","","","","2025-11-14","","","")

Input:

Example input for shorttermforecasthistory function for a specific date_forecast_run aggregate by date_prod

Output:

Example output of shorttermforecasthistory function for a specific date_forecast_run aggregate by date_prod

  1. Get short-term forecast history for a specific region_natgas and date_forecast_run aggregated by date_prod:

=SMXH4.shorttermforecasthistory("date_prod","","gulf","","","","2025-11-14","","","")

Input:

Example input for short-term forecast history function for a specific region_natgas and date_forecast_run aggregated by date_prod:

Output:

Example output of short-term forecast history function for a specific region_natgas and date_forecast_run aggregated by date_prod

  1. Get short-term forecast history for a specific operator and date_forecast_run aggregated by region_natgas and date_prod:

=SMXH4.shorttermforecasthistory("date_prod;region_natgas","US ENERCORP LTD","","","","","2025-11-14","","","")

Input:

Example input for short-term forecast history function for a specific operator and date_forecast_run aggregated by region_natgas and date_prod

Output:

Example output of short-term forecast history function for a specific operator and date_forecast_run aggregated by region_natgas and date_prod

Output Parameters#

Field

Type

Description

Example

county

string

County in the state where the well is located.

“BEAUREGARD”

date_prod

string

A date in MM/DD/YYYY format

“11/24/2022”

operator

string

A well operator

“EXXON MOBIL”

prod_oil_bbl_day

number

Daily oil production measured in barrels per day (bbl/day).

8

prod_oil_bbl_month

number

Monthly oil production measured in barrels per month (bbl/month).

29

prod_wet_gas_mcf_day

number

Daily wet gas production measured in thousand cubic feet per day (MCF/day).

16.870967

prod_wet_gas_mcf_month

number

Monthly wet gas production measured in thousand cubic feet per month (MCF/month).

523

region_natgas

string

Region divisions based on natural gas production profiles.

“gulf”

state_code

string

Abbreviation of the state.

“TX”

sub_region_natgas

string

Subregion divisions based on natural gas production profiles.

“West - TX”

Errors#

Functions may return the following error messages:

Error

Description

#VALUE!

Input parameters are invalid or cannot be parsed.

#REF!

The function cannot retrieve data from the SynMaxax API due to a network or connectivity issue.

!!! EXCEPTION

Invalid input parameters. Make sure dates are enclosed in quotes. Check if the API key is valid. To know more about how to use an API key, please check the section on authentication.

#No Data

Input data is invalid or does not exist.

Note

You can also check the logs for more information on errors. You can access the logs by clicking on SynMax Commodities on the Excel ribbon and then clicking on Logs.