Skip to main content
POST
/
v1
/
report
Submit performance report
curl --request POST \
  --url https://example-supplier.co.uk/v1/report \
  --header 'Content-Type: application/json' \
  --header 'X-Supplier-API-Key: <api-key>' \
  --data '
{
  "reporting_period_start": "2026-11-01T10:00:00.000Z",
  "reporting_period_end": "2026-11-01T10:00:00.000Z",
  "tariff_requests": 4823100,
  "tariff_changes": 12,
  "availability_pct": 99.97,
  "success_pct": 99.82,
  "response_time_ms": {
    "p50": 120,
    "p95": 820,
    "p99": 1450
  }
}
'
{
  "code": "tariff_not_found",
  "message": "No tariff found for the given tariff_id and supplier MPID.",
  "details": "tariff_id a1b2c3d4-e5f6-7890-abcd-ef1234567890 does not exist for supplier SEBD."
}

Documentation Index

Fetch the complete documentation index at: https://docs.auth.energy/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Supplier-API-Key
string
header
required

API key issued to TI Energy Suppliers for accessing restricted register data and submitting performance reports. Credentials are valid for 2 years and are distributed via a one-time URL from the Code Manager.

Body

application/json

Performance metrics submitted by a supplier to RECCo each reporting period.

​
reporting_period_start
string<date-time>
required

ISO 8601 datetime with millisecond precision.

Example:

"2026-11-01T10:00:00.000Z"

​
reporting_period_end
string<date-time>
required

ISO 8601 datetime with millisecond precision.

Example:

"2026-11-01T10:00:00.000Z"

​
tariff_requests
integer
required

Total tariff pricing data requests received during the period.

Required range: x >= 0
Example:

4823100

​
tariff_changes
integer
required

Number of tariff change notifications issued during the period.

Required range: x >= 0
Example:

12

​
availability_pct
number<float>
required

API availability during the period as a percentage. SLA target is 99.9%.

Required range: 0 <= x <= 100
Example:

99.97

​
success_pct
number<float>
required

Percentage of requests that returned a 2xx response.

Required range: 0 <= x <= 100
Example:

99.82

​
response_time_ms
object
required

API response times in milliseconds, broken down by percentile.

Response

Report accepted.

Last modified on March 28, 2026