Retrieve BESS revenue performance summaries

get

https://api.cornwall-insight.com/external/v1/bess/performance

Returns aggregated revenue performance over a chosen period, summarised by asset, by owner and byoptimiser. A date range is required. Supply exactly one of last_month, last_quarter, month_to_date or year_to_date set to true, or supply both from_date and to_date. A request with no daterange returns 400. By default all three summaries are returned. Set any of assets, optimisers or owners totrue to return only the selected summaries. Full methodology is available here.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

from_date

date

Start of a custom date range. Must be supplied together with to_date, and only when none of the preset range parameters are set to true.

to_date

date

End of a custom date range. Must be supplied together with from_date, and only when none of the preset range parameters are set to true.

last_month

string

enum

Set to true to summarise the last 30 days. Use only one preset range parameter per request, and do not combine it with from_date/to_date.

Allowed:

last_quarter

string

enum

Set to true to summarise the last 90 days. Use only one preset range parameter per request, and do not combine it with from_date/to_date.

Allowed:

month_to_date

string

enum

Set to true to summarise from the first day of the current month to today. Use only one preset range parameter per request, and do not combine it with from_date/to_date.

Allowed:

year_to_date

string

enum

Set to true to summarise from 1 January of the current year to today. Use only one preset range parameter per request, and do not combine it with from_date/to_date.

Allowed:

assets

string

enum

Set to true to include the per-asset summary. If none of assets, optimisers or owners is set to true, all three summaries are returned.

Allowed:

optimisers

string

enum

Set to true to include the per-optimiser summary. If none of assets, optimisers or owners is set to true, all three summaries are returned.

Allowed:

owners

string

enum

Set to true to include the per-owner summary. If none of assets, optimisers or owners is set to true, all three summaries are returned.

Allowed:

Responses

200Revenue performance summaries for the requested period. Only the summaries selected by the assets, optimisers and owners parameters are present; when none is selected, all three are returned.

400The request contained a parameter that is not part of this specification, or omitted a required parameter. The message field lists the offending parameter names.

401Authentication credentials missing or invalid.