Submit Forecast From Storage Object
curl --request POST \
--url https://eomer-api-cgeu.onrender.com/forecast/storage-object \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"object_id": "<string>",
"prediction_length": 24,
"presets": "eomer_pulse_l",
"item_id_column": "item_id",
"timestamp_column": "timestamp",
"target_column": "target",
"freq": "<string>",
"quantile_levels": "<string>",
"covariates": "<string>",
"latitude": 123,
"longitude": 123,
"feature_engineering": {
"enabled": true,
"time_features": true,
"cyclical_encoding": true,
"lag_features": true,
"lag_periods": [
1,
7,
14,
30
],
"rolling_features": true,
"rolling_windows": [
3,
7,
14,
30
],
"rolling_stats": [
"mean",
"std",
"min",
"max"
],
"growth_features": true,
"growth_periods": [
1,
7
],
"event_flags": true
},
"external_covariates": {
"weather": {
"enabled": false,
"source": "open_meteo",
"point_in_time": true,
"variables": [
"<string>"
],
"city": "<string>",
"latitude_column": "<string>",
"longitude_column": "<string>",
"latitude": 123,
"longitude": 123,
"resolved_location": {
"query": "<string>",
"name": "<string>",
"latitude": 123,
"longitude": 123,
"country": "<string>",
"admin1": "<string>",
"timezone": "<string>"
}
},
"holidays": {
"enabled": false,
"variables": [
"<string>"
],
"country_code": "<string>",
"subdivision_code": "<string>"
},
"fred": {
"enabled": false,
"variables": [
"<string>"
],
"future_strategy": "forward_fill_latest"
},
"air_quality": {
"enabled": false,
"point_in_time": true,
"variables": [
"<string>"
],
"city": "<string>"
},
"rates": {
"enabled": false,
"point_in_time": true,
"variables": [
"<string>"
],
"future_strategy": "forward_fill_latest"
},
"electricity": {
"enabled": false,
"point_in_time": true,
"variables": [
"<string>"
],
"bidding_zone": "<string>"
}
},
"explainability": {
"enabled": false,
"feature_importance": true,
"shap": true,
"feature_feature_correlations": true,
"feature_target_correlations": true,
"forecast_plot": true,
"rolling_regression": true,
"trailing_history_steps": 123,
"max_rows": 5000,
"max_features": 25,
"top_k_features": 15,
"shap_sample_size": 512
},
"reconciliation": {
"enabled": false,
"hierarchy_columns": [
"<string>"
],
"method": "min_trace",
"weights": "wls_struct",
"top_down_method": "proportions_of_historical_totals",
"separator": "/",
"total_label": "total",
"residual_windows": 1
},
"callback_url": "<string>"
}
'import requests
url = "https://eomer-api-cgeu.onrender.com/forecast/storage-object"
payload = {
"object_id": "<string>",
"prediction_length": 24,
"presets": "eomer_pulse_l",
"item_id_column": "item_id",
"timestamp_column": "timestamp",
"target_column": "target",
"freq": "<string>",
"quantile_levels": "<string>",
"covariates": "<string>",
"latitude": 123,
"longitude": 123,
"feature_engineering": {
"enabled": True,
"time_features": True,
"cyclical_encoding": True,
"lag_features": True,
"lag_periods": [1, 7, 14, 30],
"rolling_features": True,
"rolling_windows": [3, 7, 14, 30],
"rolling_stats": ["mean", "std", "min", "max"],
"growth_features": True,
"growth_periods": [1, 7],
"event_flags": True
},
"external_covariates": {
"weather": {
"enabled": False,
"source": "open_meteo",
"point_in_time": True,
"variables": ["<string>"],
"city": "<string>",
"latitude_column": "<string>",
"longitude_column": "<string>",
"latitude": 123,
"longitude": 123,
"resolved_location": {
"query": "<string>",
"name": "<string>",
"latitude": 123,
"longitude": 123,
"country": "<string>",
"admin1": "<string>",
"timezone": "<string>"
}
},
"holidays": {
"enabled": False,
"variables": ["<string>"],
"country_code": "<string>",
"subdivision_code": "<string>"
},
"fred": {
"enabled": False,
"variables": ["<string>"],
"future_strategy": "forward_fill_latest"
},
"air_quality": {
"enabled": False,
"point_in_time": True,
"variables": ["<string>"],
"city": "<string>"
},
"rates": {
"enabled": False,
"point_in_time": True,
"variables": ["<string>"],
"future_strategy": "forward_fill_latest"
},
"electricity": {
"enabled": False,
"point_in_time": True,
"variables": ["<string>"],
"bidding_zone": "<string>"
}
},
"explainability": {
"enabled": False,
"feature_importance": True,
"shap": True,
"feature_feature_correlations": True,
"feature_target_correlations": True,
"forecast_plot": True,
"rolling_regression": True,
"trailing_history_steps": 123,
"max_rows": 5000,
"max_features": 25,
"top_k_features": 15,
"shap_sample_size": 512
},
"reconciliation": {
"enabled": False,
"hierarchy_columns": ["<string>"],
"method": "min_trace",
"weights": "wls_struct",
"top_down_method": "proportions_of_historical_totals",
"separator": "/",
"total_label": "total",
"residual_windows": 1
},
"callback_url": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
object_id: '<string>',
prediction_length: 24,
presets: 'eomer_pulse_l',
item_id_column: 'item_id',
timestamp_column: 'timestamp',
target_column: 'target',
freq: '<string>',
quantile_levels: '<string>',
covariates: '<string>',
latitude: 123,
longitude: 123,
feature_engineering: {
enabled: true,
time_features: true,
cyclical_encoding: true,
lag_features: true,
lag_periods: [1, 7, 14, 30],
rolling_features: true,
rolling_windows: [3, 7, 14, 30],
rolling_stats: ['mean', 'std', 'min', 'max'],
growth_features: true,
growth_periods: [1, 7],
event_flags: true
},
external_covariates: {
weather: {
enabled: false,
source: 'open_meteo',
point_in_time: true,
variables: ['<string>'],
city: '<string>',
latitude_column: '<string>',
longitude_column: '<string>',
latitude: 123,
longitude: 123,
resolved_location: {
query: '<string>',
name: '<string>',
latitude: 123,
longitude: 123,
country: '<string>',
admin1: '<string>',
timezone: '<string>'
}
},
holidays: {
enabled: false,
variables: ['<string>'],
country_code: '<string>',
subdivision_code: '<string>'
},
fred: {
enabled: false,
variables: ['<string>'],
future_strategy: 'forward_fill_latest'
},
air_quality: {enabled: false, point_in_time: true, variables: ['<string>'], city: '<string>'},
rates: {
enabled: false,
point_in_time: true,
variables: ['<string>'],
future_strategy: 'forward_fill_latest'
},
electricity: {
enabled: false,
point_in_time: true,
variables: ['<string>'],
bidding_zone: '<string>'
}
},
explainability: {
enabled: false,
feature_importance: true,
shap: true,
feature_feature_correlations: true,
feature_target_correlations: true,
forecast_plot: true,
rolling_regression: true,
trailing_history_steps: 123,
max_rows: 5000,
max_features: 25,
top_k_features: 15,
shap_sample_size: 512
},
reconciliation: {
enabled: false,
hierarchy_columns: ['<string>'],
method: 'min_trace',
weights: 'wls_struct',
top_down_method: 'proportions_of_historical_totals',
separator: '/',
total_label: 'total',
residual_windows: 1
},
callback_url: '<string>'
})
};
fetch('https://eomer-api-cgeu.onrender.com/forecast/storage-object', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://eomer-api-cgeu.onrender.com/forecast/storage-object",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'object_id' => '<string>',
'prediction_length' => 24,
'presets' => 'eomer_pulse_l',
'item_id_column' => 'item_id',
'timestamp_column' => 'timestamp',
'target_column' => 'target',
'freq' => '<string>',
'quantile_levels' => '<string>',
'covariates' => '<string>',
'latitude' => 123,
'longitude' => 123,
'feature_engineering' => [
'enabled' => true,
'time_features' => true,
'cyclical_encoding' => true,
'lag_features' => true,
'lag_periods' => [
1,
7,
14,
30
],
'rolling_features' => true,
'rolling_windows' => [
3,
7,
14,
30
],
'rolling_stats' => [
'mean',
'std',
'min',
'max'
],
'growth_features' => true,
'growth_periods' => [
1,
7
],
'event_flags' => true
],
'external_covariates' => [
'weather' => [
'enabled' => false,
'source' => 'open_meteo',
'point_in_time' => true,
'variables' => [
'<string>'
],
'city' => '<string>',
'latitude_column' => '<string>',
'longitude_column' => '<string>',
'latitude' => 123,
'longitude' => 123,
'resolved_location' => [
'query' => '<string>',
'name' => '<string>',
'latitude' => 123,
'longitude' => 123,
'country' => '<string>',
'admin1' => '<string>',
'timezone' => '<string>'
]
],
'holidays' => [
'enabled' => false,
'variables' => [
'<string>'
],
'country_code' => '<string>',
'subdivision_code' => '<string>'
],
'fred' => [
'enabled' => false,
'variables' => [
'<string>'
],
'future_strategy' => 'forward_fill_latest'
],
'air_quality' => [
'enabled' => false,
'point_in_time' => true,
'variables' => [
'<string>'
],
'city' => '<string>'
],
'rates' => [
'enabled' => false,
'point_in_time' => true,
'variables' => [
'<string>'
],
'future_strategy' => 'forward_fill_latest'
],
'electricity' => [
'enabled' => false,
'point_in_time' => true,
'variables' => [
'<string>'
],
'bidding_zone' => '<string>'
]
],
'explainability' => [
'enabled' => false,
'feature_importance' => true,
'shap' => true,
'feature_feature_correlations' => true,
'feature_target_correlations' => true,
'forecast_plot' => true,
'rolling_regression' => true,
'trailing_history_steps' => 123,
'max_rows' => 5000,
'max_features' => 25,
'top_k_features' => 15,
'shap_sample_size' => 512
],
'reconciliation' => [
'enabled' => false,
'hierarchy_columns' => [
'<string>'
],
'method' => 'min_trace',
'weights' => 'wls_struct',
'top_down_method' => 'proportions_of_historical_totals',
'separator' => '/',
'total_label' => 'total',
'residual_windows' => 1
],
'callback_url' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://eomer-api-cgeu.onrender.com/forecast/storage-object"
payload := strings.NewReader("{\n \"object_id\": \"<string>\",\n \"prediction_length\": 24,\n \"presets\": \"eomer_pulse_l\",\n \"item_id_column\": \"item_id\",\n \"timestamp_column\": \"timestamp\",\n \"target_column\": \"target\",\n \"freq\": \"<string>\",\n \"quantile_levels\": \"<string>\",\n \"covariates\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"feature_engineering\": {\n \"enabled\": true,\n \"time_features\": true,\n \"cyclical_encoding\": true,\n \"lag_features\": true,\n \"lag_periods\": [\n 1,\n 7,\n 14,\n 30\n ],\n \"rolling_features\": true,\n \"rolling_windows\": [\n 3,\n 7,\n 14,\n 30\n ],\n \"rolling_stats\": [\n \"mean\",\n \"std\",\n \"min\",\n \"max\"\n ],\n \"growth_features\": true,\n \"growth_periods\": [\n 1,\n 7\n ],\n \"event_flags\": true\n },\n \"external_covariates\": {\n \"weather\": {\n \"enabled\": false,\n \"source\": \"open_meteo\",\n \"point_in_time\": true,\n \"variables\": [\n \"<string>\"\n ],\n \"city\": \"<string>\",\n \"latitude_column\": \"<string>\",\n \"longitude_column\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"resolved_location\": {\n \"query\": \"<string>\",\n \"name\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"country\": \"<string>\",\n \"admin1\": \"<string>\",\n \"timezone\": \"<string>\"\n }\n },\n \"holidays\": {\n \"enabled\": false,\n \"variables\": [\n \"<string>\"\n ],\n \"country_code\": \"<string>\",\n \"subdivision_code\": \"<string>\"\n },\n \"fred\": {\n \"enabled\": false,\n \"variables\": [\n \"<string>\"\n ],\n \"future_strategy\": \"forward_fill_latest\"\n },\n \"air_quality\": {\n \"enabled\": false,\n \"point_in_time\": true,\n \"variables\": [\n \"<string>\"\n ],\n \"city\": \"<string>\"\n },\n \"rates\": {\n \"enabled\": false,\n \"point_in_time\": true,\n \"variables\": [\n \"<string>\"\n ],\n \"future_strategy\": \"forward_fill_latest\"\n },\n \"electricity\": {\n \"enabled\": false,\n \"point_in_time\": true,\n \"variables\": [\n \"<string>\"\n ],\n \"bidding_zone\": \"<string>\"\n }\n },\n \"explainability\": {\n \"enabled\": false,\n \"feature_importance\": true,\n \"shap\": true,\n \"feature_feature_correlations\": true,\n \"feature_target_correlations\": true,\n \"forecast_plot\": true,\n \"rolling_regression\": true,\n \"trailing_history_steps\": 123,\n \"max_rows\": 5000,\n \"max_features\": 25,\n \"top_k_features\": 15,\n \"shap_sample_size\": 512\n },\n \"reconciliation\": {\n \"enabled\": false,\n \"hierarchy_columns\": [\n \"<string>\"\n ],\n \"method\": \"min_trace\",\n \"weights\": \"wls_struct\",\n \"top_down_method\": \"proportions_of_historical_totals\",\n \"separator\": \"/\",\n \"total_label\": \"total\",\n \"residual_windows\": 1\n },\n \"callback_url\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://eomer-api-cgeu.onrender.com/forecast/storage-object")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"object_id\": \"<string>\",\n \"prediction_length\": 24,\n \"presets\": \"eomer_pulse_l\",\n \"item_id_column\": \"item_id\",\n \"timestamp_column\": \"timestamp\",\n \"target_column\": \"target\",\n \"freq\": \"<string>\",\n \"quantile_levels\": \"<string>\",\n \"covariates\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"feature_engineering\": {\n \"enabled\": true,\n \"time_features\": true,\n \"cyclical_encoding\": true,\n \"lag_features\": true,\n \"lag_periods\": [\n 1,\n 7,\n 14,\n 30\n ],\n \"rolling_features\": true,\n \"rolling_windows\": [\n 3,\n 7,\n 14,\n 30\n ],\n \"rolling_stats\": [\n \"mean\",\n \"std\",\n \"min\",\n \"max\"\n ],\n \"growth_features\": true,\n \"growth_periods\": [\n 1,\n 7\n ],\n \"event_flags\": true\n },\n \"external_covariates\": {\n \"weather\": {\n \"enabled\": false,\n \"source\": \"open_meteo\",\n \"point_in_time\": true,\n \"variables\": [\n \"<string>\"\n ],\n \"city\": \"<string>\",\n \"latitude_column\": \"<string>\",\n \"longitude_column\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"resolved_location\": {\n \"query\": \"<string>\",\n \"name\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"country\": \"<string>\",\n \"admin1\": \"<string>\",\n \"timezone\": \"<string>\"\n }\n },\n \"holidays\": {\n \"enabled\": false,\n \"variables\": [\n \"<string>\"\n ],\n \"country_code\": \"<string>\",\n \"subdivision_code\": \"<string>\"\n },\n \"fred\": {\n \"enabled\": false,\n \"variables\": [\n \"<string>\"\n ],\n \"future_strategy\": \"forward_fill_latest\"\n },\n \"air_quality\": {\n \"enabled\": false,\n \"point_in_time\": true,\n \"variables\": [\n \"<string>\"\n ],\n \"city\": \"<string>\"\n },\n \"rates\": {\n \"enabled\": false,\n \"point_in_time\": true,\n \"variables\": [\n \"<string>\"\n ],\n \"future_strategy\": \"forward_fill_latest\"\n },\n \"electricity\": {\n \"enabled\": false,\n \"point_in_time\": true,\n \"variables\": [\n \"<string>\"\n ],\n \"bidding_zone\": \"<string>\"\n }\n },\n \"explainability\": {\n \"enabled\": false,\n \"feature_importance\": true,\n \"shap\": true,\n \"feature_feature_correlations\": true,\n \"feature_target_correlations\": true,\n \"forecast_plot\": true,\n \"rolling_regression\": true,\n \"trailing_history_steps\": 123,\n \"max_rows\": 5000,\n \"max_features\": 25,\n \"top_k_features\": 15,\n \"shap_sample_size\": 512\n },\n \"reconciliation\": {\n \"enabled\": false,\n \"hierarchy_columns\": [\n \"<string>\"\n ],\n \"method\": \"min_trace\",\n \"weights\": \"wls_struct\",\n \"top_down_method\": \"proportions_of_historical_totals\",\n \"separator\": \"/\",\n \"total_label\": \"total\",\n \"residual_windows\": 1\n },\n \"callback_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://eomer-api-cgeu.onrender.com/forecast/storage-object")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"object_id\": \"<string>\",\n \"prediction_length\": 24,\n \"presets\": \"eomer_pulse_l\",\n \"item_id_column\": \"item_id\",\n \"timestamp_column\": \"timestamp\",\n \"target_column\": \"target\",\n \"freq\": \"<string>\",\n \"quantile_levels\": \"<string>\",\n \"covariates\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"feature_engineering\": {\n \"enabled\": true,\n \"time_features\": true,\n \"cyclical_encoding\": true,\n \"lag_features\": true,\n \"lag_periods\": [\n 1,\n 7,\n 14,\n 30\n ],\n \"rolling_features\": true,\n \"rolling_windows\": [\n 3,\n 7,\n 14,\n 30\n ],\n \"rolling_stats\": [\n \"mean\",\n \"std\",\n \"min\",\n \"max\"\n ],\n \"growth_features\": true,\n \"growth_periods\": [\n 1,\n 7\n ],\n \"event_flags\": true\n },\n \"external_covariates\": {\n \"weather\": {\n \"enabled\": false,\n \"source\": \"open_meteo\",\n \"point_in_time\": true,\n \"variables\": [\n \"<string>\"\n ],\n \"city\": \"<string>\",\n \"latitude_column\": \"<string>\",\n \"longitude_column\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"resolved_location\": {\n \"query\": \"<string>\",\n \"name\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"country\": \"<string>\",\n \"admin1\": \"<string>\",\n \"timezone\": \"<string>\"\n }\n },\n \"holidays\": {\n \"enabled\": false,\n \"variables\": [\n \"<string>\"\n ],\n \"country_code\": \"<string>\",\n \"subdivision_code\": \"<string>\"\n },\n \"fred\": {\n \"enabled\": false,\n \"variables\": [\n \"<string>\"\n ],\n \"future_strategy\": \"forward_fill_latest\"\n },\n \"air_quality\": {\n \"enabled\": false,\n \"point_in_time\": true,\n \"variables\": [\n \"<string>\"\n ],\n \"city\": \"<string>\"\n },\n \"rates\": {\n \"enabled\": false,\n \"point_in_time\": true,\n \"variables\": [\n \"<string>\"\n ],\n \"future_strategy\": \"forward_fill_latest\"\n },\n \"electricity\": {\n \"enabled\": false,\n \"point_in_time\": true,\n \"variables\": [\n \"<string>\"\n ],\n \"bidding_zone\": \"<string>\"\n }\n },\n \"explainability\": {\n \"enabled\": false,\n \"feature_importance\": true,\n \"shap\": true,\n \"feature_feature_correlations\": true,\n \"feature_target_correlations\": true,\n \"forecast_plot\": true,\n \"rolling_regression\": true,\n \"trailing_history_steps\": 123,\n \"max_rows\": 5000,\n \"max_features\": 25,\n \"top_k_features\": 15,\n \"shap_sample_size\": 512\n },\n \"reconciliation\": {\n \"enabled\": false,\n \"hierarchy_columns\": [\n \"<string>\"\n ],\n \"method\": \"min_trace\",\n \"weights\": \"wls_struct\",\n \"top_down_method\": \"proportions_of_historical_totals\",\n \"separator\": \"/\",\n \"total_label\": \"total\",\n \"residual_windows\": 1\n },\n \"callback_url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"job_id": "<string>",
"status": "pending",
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"elapsed_seconds": 123,
"num_items": 123,
"prediction_length": 123,
"error": "<string>",
"error_code": "validation_error",
"download_url": "<string>",
"report_url": "<string>",
"external_covariate_metadata": {},
"explainability": {
"enabled": false,
"overview_markdown": "",
"selected_analyses": [
"<string>"
],
"completed_analyses": [
"<string>"
],
"skipped_analyses": {},
"warnings": [
"<string>"
],
"artifacts": [
{
"artifact_id": "<string>",
"analysis": "<string>",
"label": "<string>",
"format": "<string>",
"output_path": "<string>",
"download_url": "<string>",
"embed_url": "<string>",
"description": "",
"render_inline": false,
"preview_markdown": "",
"highlights": [
"<string>"
],
"display_order": 0,
"is_primary_visual": false,
"is_thumbnail": false
}
],
"summary_path": "<string>"
},
"explainability_url": "<string>",
"forecast_plot_url": "<string>",
"reconciliation": {},
"explanation": {
"headline": "",
"narrative": "",
"data_findings": [
"<string>"
],
"forecast_summary": [
"<string>"
],
"operational_implications": [
"<string>"
],
"caveats": [
"<string>"
],
"confidence": 0,
"generated_by": "rules"
},
"request_id": "<string>",
"config_hash": "<string>",
"dataset_hash": "<string>",
"model_version": "<string>",
"delivery_status": "<string>",
"delivery_connection_id": "<string>",
"delivery_uri": "<string>",
"delivery_error": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}API Reference
Submit Forecast From Storage Object
POST
/
forecast
/
storage-object
Submit Forecast From Storage Object
curl --request POST \
--url https://eomer-api-cgeu.onrender.com/forecast/storage-object \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"object_id": "<string>",
"prediction_length": 24,
"presets": "eomer_pulse_l",
"item_id_column": "item_id",
"timestamp_column": "timestamp",
"target_column": "target",
"freq": "<string>",
"quantile_levels": "<string>",
"covariates": "<string>",
"latitude": 123,
"longitude": 123,
"feature_engineering": {
"enabled": true,
"time_features": true,
"cyclical_encoding": true,
"lag_features": true,
"lag_periods": [
1,
7,
14,
30
],
"rolling_features": true,
"rolling_windows": [
3,
7,
14,
30
],
"rolling_stats": [
"mean",
"std",
"min",
"max"
],
"growth_features": true,
"growth_periods": [
1,
7
],
"event_flags": true
},
"external_covariates": {
"weather": {
"enabled": false,
"source": "open_meteo",
"point_in_time": true,
"variables": [
"<string>"
],
"city": "<string>",
"latitude_column": "<string>",
"longitude_column": "<string>",
"latitude": 123,
"longitude": 123,
"resolved_location": {
"query": "<string>",
"name": "<string>",
"latitude": 123,
"longitude": 123,
"country": "<string>",
"admin1": "<string>",
"timezone": "<string>"
}
},
"holidays": {
"enabled": false,
"variables": [
"<string>"
],
"country_code": "<string>",
"subdivision_code": "<string>"
},
"fred": {
"enabled": false,
"variables": [
"<string>"
],
"future_strategy": "forward_fill_latest"
},
"air_quality": {
"enabled": false,
"point_in_time": true,
"variables": [
"<string>"
],
"city": "<string>"
},
"rates": {
"enabled": false,
"point_in_time": true,
"variables": [
"<string>"
],
"future_strategy": "forward_fill_latest"
},
"electricity": {
"enabled": false,
"point_in_time": true,
"variables": [
"<string>"
],
"bidding_zone": "<string>"
}
},
"explainability": {
"enabled": false,
"feature_importance": true,
"shap": true,
"feature_feature_correlations": true,
"feature_target_correlations": true,
"forecast_plot": true,
"rolling_regression": true,
"trailing_history_steps": 123,
"max_rows": 5000,
"max_features": 25,
"top_k_features": 15,
"shap_sample_size": 512
},
"reconciliation": {
"enabled": false,
"hierarchy_columns": [
"<string>"
],
"method": "min_trace",
"weights": "wls_struct",
"top_down_method": "proportions_of_historical_totals",
"separator": "/",
"total_label": "total",
"residual_windows": 1
},
"callback_url": "<string>"
}
'import requests
url = "https://eomer-api-cgeu.onrender.com/forecast/storage-object"
payload = {
"object_id": "<string>",
"prediction_length": 24,
"presets": "eomer_pulse_l",
"item_id_column": "item_id",
"timestamp_column": "timestamp",
"target_column": "target",
"freq": "<string>",
"quantile_levels": "<string>",
"covariates": "<string>",
"latitude": 123,
"longitude": 123,
"feature_engineering": {
"enabled": True,
"time_features": True,
"cyclical_encoding": True,
"lag_features": True,
"lag_periods": [1, 7, 14, 30],
"rolling_features": True,
"rolling_windows": [3, 7, 14, 30],
"rolling_stats": ["mean", "std", "min", "max"],
"growth_features": True,
"growth_periods": [1, 7],
"event_flags": True
},
"external_covariates": {
"weather": {
"enabled": False,
"source": "open_meteo",
"point_in_time": True,
"variables": ["<string>"],
"city": "<string>",
"latitude_column": "<string>",
"longitude_column": "<string>",
"latitude": 123,
"longitude": 123,
"resolved_location": {
"query": "<string>",
"name": "<string>",
"latitude": 123,
"longitude": 123,
"country": "<string>",
"admin1": "<string>",
"timezone": "<string>"
}
},
"holidays": {
"enabled": False,
"variables": ["<string>"],
"country_code": "<string>",
"subdivision_code": "<string>"
},
"fred": {
"enabled": False,
"variables": ["<string>"],
"future_strategy": "forward_fill_latest"
},
"air_quality": {
"enabled": False,
"point_in_time": True,
"variables": ["<string>"],
"city": "<string>"
},
"rates": {
"enabled": False,
"point_in_time": True,
"variables": ["<string>"],
"future_strategy": "forward_fill_latest"
},
"electricity": {
"enabled": False,
"point_in_time": True,
"variables": ["<string>"],
"bidding_zone": "<string>"
}
},
"explainability": {
"enabled": False,
"feature_importance": True,
"shap": True,
"feature_feature_correlations": True,
"feature_target_correlations": True,
"forecast_plot": True,
"rolling_regression": True,
"trailing_history_steps": 123,
"max_rows": 5000,
"max_features": 25,
"top_k_features": 15,
"shap_sample_size": 512
},
"reconciliation": {
"enabled": False,
"hierarchy_columns": ["<string>"],
"method": "min_trace",
"weights": "wls_struct",
"top_down_method": "proportions_of_historical_totals",
"separator": "/",
"total_label": "total",
"residual_windows": 1
},
"callback_url": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
object_id: '<string>',
prediction_length: 24,
presets: 'eomer_pulse_l',
item_id_column: 'item_id',
timestamp_column: 'timestamp',
target_column: 'target',
freq: '<string>',
quantile_levels: '<string>',
covariates: '<string>',
latitude: 123,
longitude: 123,
feature_engineering: {
enabled: true,
time_features: true,
cyclical_encoding: true,
lag_features: true,
lag_periods: [1, 7, 14, 30],
rolling_features: true,
rolling_windows: [3, 7, 14, 30],
rolling_stats: ['mean', 'std', 'min', 'max'],
growth_features: true,
growth_periods: [1, 7],
event_flags: true
},
external_covariates: {
weather: {
enabled: false,
source: 'open_meteo',
point_in_time: true,
variables: ['<string>'],
city: '<string>',
latitude_column: '<string>',
longitude_column: '<string>',
latitude: 123,
longitude: 123,
resolved_location: {
query: '<string>',
name: '<string>',
latitude: 123,
longitude: 123,
country: '<string>',
admin1: '<string>',
timezone: '<string>'
}
},
holidays: {
enabled: false,
variables: ['<string>'],
country_code: '<string>',
subdivision_code: '<string>'
},
fred: {
enabled: false,
variables: ['<string>'],
future_strategy: 'forward_fill_latest'
},
air_quality: {enabled: false, point_in_time: true, variables: ['<string>'], city: '<string>'},
rates: {
enabled: false,
point_in_time: true,
variables: ['<string>'],
future_strategy: 'forward_fill_latest'
},
electricity: {
enabled: false,
point_in_time: true,
variables: ['<string>'],
bidding_zone: '<string>'
}
},
explainability: {
enabled: false,
feature_importance: true,
shap: true,
feature_feature_correlations: true,
feature_target_correlations: true,
forecast_plot: true,
rolling_regression: true,
trailing_history_steps: 123,
max_rows: 5000,
max_features: 25,
top_k_features: 15,
shap_sample_size: 512
},
reconciliation: {
enabled: false,
hierarchy_columns: ['<string>'],
method: 'min_trace',
weights: 'wls_struct',
top_down_method: 'proportions_of_historical_totals',
separator: '/',
total_label: 'total',
residual_windows: 1
},
callback_url: '<string>'
})
};
fetch('https://eomer-api-cgeu.onrender.com/forecast/storage-object', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://eomer-api-cgeu.onrender.com/forecast/storage-object",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'object_id' => '<string>',
'prediction_length' => 24,
'presets' => 'eomer_pulse_l',
'item_id_column' => 'item_id',
'timestamp_column' => 'timestamp',
'target_column' => 'target',
'freq' => '<string>',
'quantile_levels' => '<string>',
'covariates' => '<string>',
'latitude' => 123,
'longitude' => 123,
'feature_engineering' => [
'enabled' => true,
'time_features' => true,
'cyclical_encoding' => true,
'lag_features' => true,
'lag_periods' => [
1,
7,
14,
30
],
'rolling_features' => true,
'rolling_windows' => [
3,
7,
14,
30
],
'rolling_stats' => [
'mean',
'std',
'min',
'max'
],
'growth_features' => true,
'growth_periods' => [
1,
7
],
'event_flags' => true
],
'external_covariates' => [
'weather' => [
'enabled' => false,
'source' => 'open_meteo',
'point_in_time' => true,
'variables' => [
'<string>'
],
'city' => '<string>',
'latitude_column' => '<string>',
'longitude_column' => '<string>',
'latitude' => 123,
'longitude' => 123,
'resolved_location' => [
'query' => '<string>',
'name' => '<string>',
'latitude' => 123,
'longitude' => 123,
'country' => '<string>',
'admin1' => '<string>',
'timezone' => '<string>'
]
],
'holidays' => [
'enabled' => false,
'variables' => [
'<string>'
],
'country_code' => '<string>',
'subdivision_code' => '<string>'
],
'fred' => [
'enabled' => false,
'variables' => [
'<string>'
],
'future_strategy' => 'forward_fill_latest'
],
'air_quality' => [
'enabled' => false,
'point_in_time' => true,
'variables' => [
'<string>'
],
'city' => '<string>'
],
'rates' => [
'enabled' => false,
'point_in_time' => true,
'variables' => [
'<string>'
],
'future_strategy' => 'forward_fill_latest'
],
'electricity' => [
'enabled' => false,
'point_in_time' => true,
'variables' => [
'<string>'
],
'bidding_zone' => '<string>'
]
],
'explainability' => [
'enabled' => false,
'feature_importance' => true,
'shap' => true,
'feature_feature_correlations' => true,
'feature_target_correlations' => true,
'forecast_plot' => true,
'rolling_regression' => true,
'trailing_history_steps' => 123,
'max_rows' => 5000,
'max_features' => 25,
'top_k_features' => 15,
'shap_sample_size' => 512
],
'reconciliation' => [
'enabled' => false,
'hierarchy_columns' => [
'<string>'
],
'method' => 'min_trace',
'weights' => 'wls_struct',
'top_down_method' => 'proportions_of_historical_totals',
'separator' => '/',
'total_label' => 'total',
'residual_windows' => 1
],
'callback_url' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://eomer-api-cgeu.onrender.com/forecast/storage-object"
payload := strings.NewReader("{\n \"object_id\": \"<string>\",\n \"prediction_length\": 24,\n \"presets\": \"eomer_pulse_l\",\n \"item_id_column\": \"item_id\",\n \"timestamp_column\": \"timestamp\",\n \"target_column\": \"target\",\n \"freq\": \"<string>\",\n \"quantile_levels\": \"<string>\",\n \"covariates\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"feature_engineering\": {\n \"enabled\": true,\n \"time_features\": true,\n \"cyclical_encoding\": true,\n \"lag_features\": true,\n \"lag_periods\": [\n 1,\n 7,\n 14,\n 30\n ],\n \"rolling_features\": true,\n \"rolling_windows\": [\n 3,\n 7,\n 14,\n 30\n ],\n \"rolling_stats\": [\n \"mean\",\n \"std\",\n \"min\",\n \"max\"\n ],\n \"growth_features\": true,\n \"growth_periods\": [\n 1,\n 7\n ],\n \"event_flags\": true\n },\n \"external_covariates\": {\n \"weather\": {\n \"enabled\": false,\n \"source\": \"open_meteo\",\n \"point_in_time\": true,\n \"variables\": [\n \"<string>\"\n ],\n \"city\": \"<string>\",\n \"latitude_column\": \"<string>\",\n \"longitude_column\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"resolved_location\": {\n \"query\": \"<string>\",\n \"name\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"country\": \"<string>\",\n \"admin1\": \"<string>\",\n \"timezone\": \"<string>\"\n }\n },\n \"holidays\": {\n \"enabled\": false,\n \"variables\": [\n \"<string>\"\n ],\n \"country_code\": \"<string>\",\n \"subdivision_code\": \"<string>\"\n },\n \"fred\": {\n \"enabled\": false,\n \"variables\": [\n \"<string>\"\n ],\n \"future_strategy\": \"forward_fill_latest\"\n },\n \"air_quality\": {\n \"enabled\": false,\n \"point_in_time\": true,\n \"variables\": [\n \"<string>\"\n ],\n \"city\": \"<string>\"\n },\n \"rates\": {\n \"enabled\": false,\n \"point_in_time\": true,\n \"variables\": [\n \"<string>\"\n ],\n \"future_strategy\": \"forward_fill_latest\"\n },\n \"electricity\": {\n \"enabled\": false,\n \"point_in_time\": true,\n \"variables\": [\n \"<string>\"\n ],\n \"bidding_zone\": \"<string>\"\n }\n },\n \"explainability\": {\n \"enabled\": false,\n \"feature_importance\": true,\n \"shap\": true,\n \"feature_feature_correlations\": true,\n \"feature_target_correlations\": true,\n \"forecast_plot\": true,\n \"rolling_regression\": true,\n \"trailing_history_steps\": 123,\n \"max_rows\": 5000,\n \"max_features\": 25,\n \"top_k_features\": 15,\n \"shap_sample_size\": 512\n },\n \"reconciliation\": {\n \"enabled\": false,\n \"hierarchy_columns\": [\n \"<string>\"\n ],\n \"method\": \"min_trace\",\n \"weights\": \"wls_struct\",\n \"top_down_method\": \"proportions_of_historical_totals\",\n \"separator\": \"/\",\n \"total_label\": \"total\",\n \"residual_windows\": 1\n },\n \"callback_url\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://eomer-api-cgeu.onrender.com/forecast/storage-object")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"object_id\": \"<string>\",\n \"prediction_length\": 24,\n \"presets\": \"eomer_pulse_l\",\n \"item_id_column\": \"item_id\",\n \"timestamp_column\": \"timestamp\",\n \"target_column\": \"target\",\n \"freq\": \"<string>\",\n \"quantile_levels\": \"<string>\",\n \"covariates\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"feature_engineering\": {\n \"enabled\": true,\n \"time_features\": true,\n \"cyclical_encoding\": true,\n \"lag_features\": true,\n \"lag_periods\": [\n 1,\n 7,\n 14,\n 30\n ],\n \"rolling_features\": true,\n \"rolling_windows\": [\n 3,\n 7,\n 14,\n 30\n ],\n \"rolling_stats\": [\n \"mean\",\n \"std\",\n \"min\",\n \"max\"\n ],\n \"growth_features\": true,\n \"growth_periods\": [\n 1,\n 7\n ],\n \"event_flags\": true\n },\n \"external_covariates\": {\n \"weather\": {\n \"enabled\": false,\n \"source\": \"open_meteo\",\n \"point_in_time\": true,\n \"variables\": [\n \"<string>\"\n ],\n \"city\": \"<string>\",\n \"latitude_column\": \"<string>\",\n \"longitude_column\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"resolved_location\": {\n \"query\": \"<string>\",\n \"name\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"country\": \"<string>\",\n \"admin1\": \"<string>\",\n \"timezone\": \"<string>\"\n }\n },\n \"holidays\": {\n \"enabled\": false,\n \"variables\": [\n \"<string>\"\n ],\n \"country_code\": \"<string>\",\n \"subdivision_code\": \"<string>\"\n },\n \"fred\": {\n \"enabled\": false,\n \"variables\": [\n \"<string>\"\n ],\n \"future_strategy\": \"forward_fill_latest\"\n },\n \"air_quality\": {\n \"enabled\": false,\n \"point_in_time\": true,\n \"variables\": [\n \"<string>\"\n ],\n \"city\": \"<string>\"\n },\n \"rates\": {\n \"enabled\": false,\n \"point_in_time\": true,\n \"variables\": [\n \"<string>\"\n ],\n \"future_strategy\": \"forward_fill_latest\"\n },\n \"electricity\": {\n \"enabled\": false,\n \"point_in_time\": true,\n \"variables\": [\n \"<string>\"\n ],\n \"bidding_zone\": \"<string>\"\n }\n },\n \"explainability\": {\n \"enabled\": false,\n \"feature_importance\": true,\n \"shap\": true,\n \"feature_feature_correlations\": true,\n \"feature_target_correlations\": true,\n \"forecast_plot\": true,\n \"rolling_regression\": true,\n \"trailing_history_steps\": 123,\n \"max_rows\": 5000,\n \"max_features\": 25,\n \"top_k_features\": 15,\n \"shap_sample_size\": 512\n },\n \"reconciliation\": {\n \"enabled\": false,\n \"hierarchy_columns\": [\n \"<string>\"\n ],\n \"method\": \"min_trace\",\n \"weights\": \"wls_struct\",\n \"top_down_method\": \"proportions_of_historical_totals\",\n \"separator\": \"/\",\n \"total_label\": \"total\",\n \"residual_windows\": 1\n },\n \"callback_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://eomer-api-cgeu.onrender.com/forecast/storage-object")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"object_id\": \"<string>\",\n \"prediction_length\": 24,\n \"presets\": \"eomer_pulse_l\",\n \"item_id_column\": \"item_id\",\n \"timestamp_column\": \"timestamp\",\n \"target_column\": \"target\",\n \"freq\": \"<string>\",\n \"quantile_levels\": \"<string>\",\n \"covariates\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"feature_engineering\": {\n \"enabled\": true,\n \"time_features\": true,\n \"cyclical_encoding\": true,\n \"lag_features\": true,\n \"lag_periods\": [\n 1,\n 7,\n 14,\n 30\n ],\n \"rolling_features\": true,\n \"rolling_windows\": [\n 3,\n 7,\n 14,\n 30\n ],\n \"rolling_stats\": [\n \"mean\",\n \"std\",\n \"min\",\n \"max\"\n ],\n \"growth_features\": true,\n \"growth_periods\": [\n 1,\n 7\n ],\n \"event_flags\": true\n },\n \"external_covariates\": {\n \"weather\": {\n \"enabled\": false,\n \"source\": \"open_meteo\",\n \"point_in_time\": true,\n \"variables\": [\n \"<string>\"\n ],\n \"city\": \"<string>\",\n \"latitude_column\": \"<string>\",\n \"longitude_column\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"resolved_location\": {\n \"query\": \"<string>\",\n \"name\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"country\": \"<string>\",\n \"admin1\": \"<string>\",\n \"timezone\": \"<string>\"\n }\n },\n \"holidays\": {\n \"enabled\": false,\n \"variables\": [\n \"<string>\"\n ],\n \"country_code\": \"<string>\",\n \"subdivision_code\": \"<string>\"\n },\n \"fred\": {\n \"enabled\": false,\n \"variables\": [\n \"<string>\"\n ],\n \"future_strategy\": \"forward_fill_latest\"\n },\n \"air_quality\": {\n \"enabled\": false,\n \"point_in_time\": true,\n \"variables\": [\n \"<string>\"\n ],\n \"city\": \"<string>\"\n },\n \"rates\": {\n \"enabled\": false,\n \"point_in_time\": true,\n \"variables\": [\n \"<string>\"\n ],\n \"future_strategy\": \"forward_fill_latest\"\n },\n \"electricity\": {\n \"enabled\": false,\n \"point_in_time\": true,\n \"variables\": [\n \"<string>\"\n ],\n \"bidding_zone\": \"<string>\"\n }\n },\n \"explainability\": {\n \"enabled\": false,\n \"feature_importance\": true,\n \"shap\": true,\n \"feature_feature_correlations\": true,\n \"feature_target_correlations\": true,\n \"forecast_plot\": true,\n \"rolling_regression\": true,\n \"trailing_history_steps\": 123,\n \"max_rows\": 5000,\n \"max_features\": 25,\n \"top_k_features\": 15,\n \"shap_sample_size\": 512\n },\n \"reconciliation\": {\n \"enabled\": false,\n \"hierarchy_columns\": [\n \"<string>\"\n ],\n \"method\": \"min_trace\",\n \"weights\": \"wls_struct\",\n \"top_down_method\": \"proportions_of_historical_totals\",\n \"separator\": \"/\",\n \"total_label\": \"total\",\n \"residual_windows\": 1\n },\n \"callback_url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"job_id": "<string>",
"status": "pending",
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"elapsed_seconds": 123,
"num_items": 123,
"prediction_length": 123,
"error": "<string>",
"error_code": "validation_error",
"download_url": "<string>",
"report_url": "<string>",
"external_covariate_metadata": {},
"explainability": {
"enabled": false,
"overview_markdown": "",
"selected_analyses": [
"<string>"
],
"completed_analyses": [
"<string>"
],
"skipped_analyses": {},
"warnings": [
"<string>"
],
"artifacts": [
{
"artifact_id": "<string>",
"analysis": "<string>",
"label": "<string>",
"format": "<string>",
"output_path": "<string>",
"download_url": "<string>",
"embed_url": "<string>",
"description": "",
"render_inline": false,
"preview_markdown": "",
"highlights": [
"<string>"
],
"display_order": 0,
"is_primary_visual": false,
"is_thumbnail": false
}
],
"summary_path": "<string>"
},
"explainability_url": "<string>",
"forecast_plot_url": "<string>",
"reconciliation": {},
"explanation": {
"headline": "",
"narrative": "",
"data_findings": [
"<string>"
],
"forecast_summary": [
"<string>"
],
"operational_implications": [
"<string>"
],
"caveats": [
"<string>"
],
"confidence": 0,
"generated_by": "rules"
},
"request_id": "<string>",
"config_hash": "<string>",
"dataset_hash": "<string>",
"model_version": "<string>",
"delivery_status": "<string>",
"delivery_connection_id": "<string>",
"delivery_uri": "<string>",
"delivery_error": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Request body for submitting a forecast job from a stored object.
Required string length:
1 - 128Required range:
x >= 1Required string length:
1 - 128Required string length:
1 - 200Required string length:
1 - 200Required string length:
1 - 200Maximum string length:
20Maximum string length:
200Maximum string length:
500Internal covariate generation from the dataset itself. When enabled, deterministic features (calendar, cyclical encodings, lag, rolling statistics, growth metrics, and event flags) are generated and injected as covariates before model fitting.
Show child attributes
Show child attributes
External covariate source settings.
Show child attributes
Show child attributes
Optional post-forecast explainability analyses and artifacts.
Show child attributes
Show child attributes
Reconcile forecasts across a summation hierarchy. When enabled, the pipeline derives every hierarchy level from
hierarchy_columns (aggregate series are forecast alongside the bottom
ones) and post-adjusts all forecasts to coherence: each parent equals the
sum of its children.
Show child attributes
Show child attributes
Maximum string length:
2048Response
Successful Response
Response model for job status queries.
Status values for async forecast jobs.
Available options:
pending, running, completed, failed Machine-readable error codes for agent-friendly error handling.
Available options:
validation_error, invalid_preset, file_too_large, rate_limited, server_overloaded, job_not_found, job_not_completed, auth_failed, internal_error, timeout, pipeline_failed, storage_error, gpu_offload_unavailable, connection_not_found, connector_error, sandbox_domain_used, sandbox_captcha_failed, sandbox_dataset_too_large, sandbox_corporate_email_required Explainability execution status for a forecast job.
Show child attributes
Show child attributes
Post-forecast business explanation surfaced on a completed job. Written by the explanation agent (the second LLM in the agentic "sandwich"). Always vendor-neutral — the backend sanitizes every field before persisting, so no underlying model/vendor name appears here.
Show child attributes
Show child attributes
⌘I