EmissionsForecastDTO

interface EmissionsForecastDTO {
    dataEndAt?: string;
    dataStartAt?: string;
    forecastData?: EmissionsDataDTO[];
    generatedAt?: string;
    location?: string;
    optimalDataPoints?: EmissionsDataDTO[];
    requestedAt?: string;
    windowSize?: number;
}

Properties

dataEndAt?: string

End time boundary of forecasted data points. Ignores forecast data points after this time. Defaults to the latest time in the forecast data.

EmissionsForecastDTO

dataStartAt?: string

Start time boundary of forecasted data points. Ignores forecast data points before this time. Defaults to the earliest time in the forecast data.

EmissionsForecastDTO

forecastData?: EmissionsDataDTO[]

The forecasted data points transformed and filtered to reflect the specified time and window parameters. Points are ordered chronologically; Empty array if all data points were filtered out. E.G. dataStartAt and dataEndAt times outside the forecast period; windowSize greater than total duration of forecast data;

EmissionsForecastDTO

generatedAt?: string

Timestamp when the forecast was generated.

EmissionsForecastDTO

location?: string

The location of the forecast

EmissionsForecastDTO

optimalDataPoints?: EmissionsDataDTO[]

The optimal forecasted data point within the 'forecastData' array. Null if 'forecastData' array is empty.

EmissionsForecastDTO

requestedAt?: string

For current requests, this value is the timestamp the request for forecast data was made. For historical forecast requests, this value is the timestamp used to access the most recently generated forecast as of that time.

EmissionsForecastDTO

windowSize?: number

The estimated duration (in minutes) of the workload. Defaults to the duration of a single forecast data point.

EmissionsForecastDTO