Skip to main content
GET
Forecast summary aggregated by dimension

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

Page of items

meta
object
required

Pagination metadata

success
enum<boolean>
required
Available options:
true