Forecast summary aggregated by dimension
curl --request GET \
--url https://app.solya.app/api/forecasts/summary \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.solya.app/api/forecasts/summary"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.solya.app/api/forecasts/summary', 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://app.solya.app/api/forecasts/summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.solya.app/api/forecasts/summary"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.solya.app/api/forecasts/summary")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.solya.app/api/forecasts/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"forecastQty": 1820,
"lowerBoundQty": 1540,
"shopId": "shop-paris-001",
"upperBoundQty": 2110,
"variantId": null
},
{
"forecastQty": 1310,
"lowerBoundQty": 1090,
"shopId": "shop-lyon-002",
"upperBoundQty": 1530,
"variantId": null
}
],
"meta": {
"page": 1,
"pageSize": 20,
"total": 6
}
}Analytics
Forecast summary aggregated by dimension
Returns a paginated demand forecast aggregated by shop or variant over a forecast-date range. forecastQty is the point estimate; lowerBoundQty and upperBoundQty are the confidence-interval bounds.
GET
/
api
/
forecasts
/
summary
Forecast summary aggregated by dimension
curl --request GET \
--url https://app.solya.app/api/forecasts/summary \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.solya.app/api/forecasts/summary"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.solya.app/api/forecasts/summary', 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://app.solya.app/api/forecasts/summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.solya.app/api/forecasts/summary"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.solya.app/api/forecasts/summary")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.solya.app/api/forecasts/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"forecastQty": 1820,
"lowerBoundQty": 1540,
"shopId": "shop-paris-001",
"upperBoundQty": 2110,
"variantId": null
},
{
"forecastQty": 1310,
"lowerBoundQty": 1090,
"shopId": "shop-lyon-002",
"upperBoundQty": 1530,
"variantId": null
}
],
"meta": {
"page": 1,
"pageSize": 20,
"total": 6
}
}Authorizations
User session token issued by NextAuth. For human users accessing Solya via the web application.
Query Parameters
Page number, 1-indexed (default: 1)
Required range:
1 <= x <= 9007199254740991Number of items per page, max 100 (default: 20)
Required range:
1 <= x <= 100Aggregation dimension: shop (default) or variant
Available options:
shop, variant Start of forecast-date range, inclusive (YYYY-MM-DD)
Pattern:
^\d{4}-\d{2}-\d{2}$End of forecast-date range, inclusive (YYYY-MM-DD)
Pattern:
^\d{4}-\d{2}-\d{2}$Comma-separated shop IDs to filter by
Metric to sort by: forecastQty (default), lowerBoundQty, or upperBoundQty
Available options:
forecastQty, lowerBoundQty, upperBoundQty Sort direction: desc (default) or asc
Available options:
asc, desc 
