Sign in

v1

latestOpenAPI 3.0.0BSD License2026-07-24228233924.5 KB
Forecasts

Get Forecast Run Results

Returns results for a completed forecast run at the requested resolution.

Results are returned in column-oriented format: each entry in columns has a label, a display_label, and a data array of length periods. Timestamps are implicit — derive them from data_start, the resolution, and the array index.

Use ?columns= to request a subset of columns by label. Omit the parameter to return all available columns.

Returns 404 if the run has not yet completed. Poll GET /runs/{id}/ until status is ready_for_review before calling this endpoint.

get/runs/{id}/results/{resolution}/

Path parameters

idstring uuid required

The forecast run ID.

resolution'monthly' | 'annual' required

Time resolution of the results to return.

Query parameters

columnsstring

Comma-separated list of column labels to include (e.g. total_revenue,avg_cycles_per_day). Omit to return all columns.

Response

Results for the requested resolution.

data_startstring

Start of the results data. YYYY-MM format for monthly (e.g. 2025-01); YYYY format for annual (e.g. 2025).

periodsinteger

Number of periods in the data. Equal to the length of every data array.

resolution'monthly' | 'annual'

The resolution of the returned data, matching the path parameter.

Example response

{
  "data_start": "2025-01"
}