v1

latestOpenAPI 3.0.42026-07-233182951.4 MB

Data Status

Status of ingested BOD Data

This endpoint provides information about the number of data points ingested for the BOD dataset.

The settlementDateFrom and settlementDateTo query parameters are optional. If they're not provided, the endpoint will return data for up to the last 25 Settlement Periods, including the current one.

get/data-status/BOD

Query parameters

settlementDateFromstring date

Example:2022-09-20

The settlement date from filter. This must be in the format yyyy-MM-dd.

settlementDateTostring date

Example:2022-09-21

The settlement date to filter. This must be in the format yyyy-MM-dd.

format'json' | 'xml' | 'csv'

Response data format. Use json/xml to include metadata.

Response

Data retrieved

Example response

{
  "data": [
    {
      "settlementDate": "2021-12-05",
      "settlementPeriod": 14,
      "dataPointCount": 31
    }
  ],
  "metadata": {
    "datasets": [
      "DATASET"
    ]
  }
}