elexon-data / insights-issues

This repository serves as a centralised location for tracking and managing issues reported on the Insights Solution.
MIT License
4 stars 0 forks source link

Inconsistent input parameters across historical reports #5

Open Samreay opened 1 year ago

Samreay commented 1 year ago

Describe the issue

Inputs are not standardised across historical data endpoints.

Expected behaviour

A common interface for requesting data as much as possible.

Observed behaviour

  1. TSDF report takes: publishDateTimeFrom and publishDateTimeTo
  2. MELS report takes from and to
  3. The balancing dynamic report takes snapshotAt and until
  4. The balancing dynamic report market-wide report takes settlementDate and settlementPeriod
  5. The historic forteen day generation forecast takes publishTime
  6. The initial demand outturn report takes settlementDateFrom and settlementDateTo
  7. The system frequency report takes from and to
  8. The system frequency FREQ stream report takes measurementDateTimeFrom and measurementDateTimeTo
  9. The generation by type report takes startTime and endTime

It would be great of those inputs could be standardised a bit. Things like the STREAM endpoints are the most consistent so far.

It would be great to work towards a common interface that has the from, to, publish_from, publish_to as consistent inputs to all reports for historical data.

Checks

Please answer the following questions for yourself before submitting an issue.

Samreay commented 1 year ago

Btw @robin-leach, theres a check box there for adding the correct labels. This isn't something someone opening an issue can do, labels can only be managed by collaborators.

zghanty commented 1 year ago

Hey Sam - indeed we have items in the backlog to standardise the API endpoints; we do not have ETA yet and have prioritised features and releasing new datasets.

Samreay commented 1 year ago

All good. Are those new endpoints being proritised going to follow some form of access standardisation?