Historic Analysis

post

https://enact-functionapp-siteapi.azurewebsites.net/api/EnactHistoricAnalysis

Body Params

seriesOptions

array of objects

required

The series to retrieve data for.

seriesOptions*

fromDate

date-time

required

Defaults to 2023-10-01T00:00:00Z

The start of the date range to return data for.

toDate

date-time

required

Defaults to 2023-10-31T00:00:00Z

The end of the date range to return data for (inclusive).

filters

array of objects

Filters to apply to the returned data. For example, only return data when the daily maximum of Demand Outturn was greater than 45,000MW.

filters

filterCondition

string

The condition used to aggregtate the filters; "and" (default), "or".

aggregateOptions

object

timeZone

string

The TimeZone of the returned data (UTC by default).

outputHalfHourly

boolean

Defaults to false

Setting this to true will average values of the returned data for higher granularity series to half-hourly.

showMissingData

boolean

Defaults to false

Setting this to true will include rows in the return object where data is missing (this does not apply to days excluded by filters).

Responses

Language

Credentials

OAuth2

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200