Skip to main content
GET
/
api
/
forecasts
/
summary
Forecast summary aggregated by dimension
curl --request GET \
  --url https://app.solya.app/api/forecasts/summary \
  --header 'Authorization: Bearer <token>'
{
  "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
    }
  ],
  "page": 1,
  "pageSize": 20,
  "total": 6
}

Authorizations

​
Authorization
string
header
required

User session token issued by NextAuth. For human users accessing Solya via the web application.

Query Parameters

​
page
integer
default:1

Page number, 1-indexed (default: 1)

Required range: 1 <= x <= 9007199254740991
​
pageSize
integer
default:20

Number of items per page, max 100 (default: 20)

Required range: 1 <= x <= 100
​
groupBy
enum<string>
default:shop

Aggregation dimension: shop (default) or variant

Available options:
shop,
variant
​
from
string
required

Start of forecast-date range, inclusive (YYYY-MM-DD)

Pattern: ^\d{4}-\d{2}-\d{2}$
​
to
string
required

End of forecast-date range, inclusive (YYYY-MM-DD)

Pattern: ^\d{4}-\d{2}-\d{2}$
​
shopIds
string

Comma-separated shop IDs to filter by

​
sortBy
enum<string>
default:forecastQty

Metric to sort by: forecastQty (default), lowerBoundQty, or upperBoundQty

Available options:
forecastQty,
lowerBoundQty,
upperBoundQty
​
sortDir
enum<string>
default:desc

Sort direction: desc (default) or asc

Available options:
asc,
desc

Response

Successful response

​
data
object
required
​
success
enum<boolean>
required
Available options:
true