Consumer Data Right (Energy) Data Holder Admin API
Data Holder Admin endpoints
Consumer Data Right (Energy) Data Holder Admin API is one of 17 APIs that Consumer Data Right (Energy) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Data Holder Admin. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, authentication docs, and a GitHub repository.
This API exposes 2 operations across 2 paths, and defines 88 schemas. It is described by OpenAPI 3.2.0, at version 1.36.0.
Requests are made against a single base URL, https://mtls.dh.example.com/cds-au/v1.
2 operations
2 paths
88 schemas
1 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Data Holder Admin 2
Data Holder Admin endpoints
POST
/admin/register/metadata
Metadata Update
GET
/admin/metrics
Get Metrics
Schemas 88
The contract defines 88 schemas that model the data the API accepts and returns. The most detailed are ResponseMetricsListV5_data (14 properties), PerformanceMetricsV3 (8 properties), InvocationMetricsV3 (7 properties), AverageResponseMetricsV2 (7 properties). Each schema is shown below with its type and property counts.
InvocationMetricsV3_highPriority
object
API call counts for the high priority tier.
2 properties
AvailabilityMetricsV2_unauthenticated
object
Availability metrics for the unauthenticated aspects of the CDR regime.
2 properties
PeakTPSMetricsV2_aggregate
object
Aggregate peak transactions per second, over time, for all endpoints.
2 properties
RejectionMetricsV3_authenticated
object
Rejection counts for all authenticated endpoints.
2 properties
AverageResponseMetricsV2_unattended
object
Average response time for the unattended tier.
2 properties
InvocationMetricsV3
object
Number of API calls in each performance tier, over time.
7 properties
5 required
AverageTPSMetricsV2_authenticated
object
Average transactions per second, over time, for authenticated endpoints.
2 properties
SecondaryHolderMetricsV2_rejections
object
Number of calls rejected due to traffic thresholds, over time.
2 properties
InvocationMetricsV3_lowPriority
object
API call counts for the low priority tier.
2 properties
AverageResponseMetricsV2_secondary_secondary
object
Average response time as measured for the secondary data holder.
2 properties
AvailabilityMetricsV2_authenticated
object
Availability metrics for the authenticated aspects of the CDR regime.
2 properties
PerformanceMetricsV3_largeSecondary_primary
object
Percentage of large Shared Responsibility calls within the performance thresholds for the secondary data holder.
2 properties
AuthorisationMetricsV2
object
Authorisation counts for the data holder.
7 properties
7 required
AverageTPSMetricsV2_aggregate
object
Aggregate average transactions per second, over time, for all endpoints.
2 properties
ErrorMetricsV2
object
Number of calls resulting in error, over time.
3 properties
3 required
AuthorisationMetricsV2_amendedAuthorisationCount_currentDay
object
Number of amended authorisations for the current day.
2 properties
2 required
AuthorisationMetricsV2_revokedAuthorisationCount
object
The number of revoked authorisations.
2 properties
AverageResponseMetricsV2
object
Average response time in seconds, at millisecond resolution, within each performance tier.
7 properties
5 required
InvocationMetricsV3_largeSecondary
object
API call counts for the large Shared Responsibility Data Requests tier. Mandatory for data holders designated for a Shared Responsibility Data Request data clu…
2 properties
PerformanceMetricsV3_unauthenticated
object
Percentage of unauthenticated calls within the performance thresholds.
2 properties
ResponseMetricsListV5
object
3 properties
2 required
AuthorisationMetricsV2_abandonmentsByStage
object
Customer abandonment count per stage of the consent flow. Note that the aggregated abandonment count for all stages for a period should equal the count in aban…
6 properties
6 required
InvocationMetricsV3_unauthenticated
object
API call counts for the unauthenticated tier.
2 properties
ResponseMetricsListV5_data
object
14 properties
13 required
PerformanceMetricsV3_lowPriority
object
Percentage of low priority calls within the performance thresholds.
2 properties
AuthorisationMetricsV2_abandonmentsByStage_preAuthentication
object
The number of authorisations where the customer identified themselves (i.e. they successfully identify the customer profile to use for the authorisation) but f…
2 properties
ErrorV2
object
4 properties
3 required
AuthorisationMetricsV2_amendedAuthorisationCount_previousDays
object
2 properties
2 required
AverageResponseMetricsV2_secondary
object
Average response time for the secondary tier. Mandatory for data holders designated for a Shared Responsibility Data Request data cluster.
2 properties
2 required
AuthorisationMetricsV2_expiredAuthorisationCount_previousDays
object
2 properties
2 required
ErrorMetricsV2_authenticated
object
Number of calls resulting in error for authenticated endpoints.
2 properties
RequestMetaDataUpdateV1_data
object
1 property
1 required
AverageTPSMetricsV2
object
Average transactions per second, over time.
3 properties
3 required
InvocationMetricsV3_secondary
object
API call counts for the Shared Responsibility Data Requests tier. Mandatory for data holders designated for a Shared Responsibility Data Request data cluster.
2 properties
ResponseErrorListV2
object
1 property
1 required
AuthorisationMetricsV2_abandonmentsByStage_rejected
object
The number of authorisations where the customer actively rejected the authorisation rather than abandoning the process.
2 properties
AvailabilityMetricsV2
object
Availability metrics.
3 properties
3 required
AverageResponseMetricsV2_largeSecondary
object
Average response time for the large payload tier. Mandatory for data holders designated for a Shared Responsibility Data Request data cluster.
2 properties
2 required
PeakTPSMetricsV2
object
Peak transactions per second, over time.
3 properties
3 required
PeakTPSMetricsV2_authenticated
object
Peak transactions per second, over time, for authenticated endpoints.
2 properties
PerformanceHours
string
Percentage of calls within the performance threshold for the specified hour. 0.0 means 0%. 1.0 means 100%. Must be a positive value or zero.
ErrorV2_meta
object
Additional data for customised error codes.
1 property
PerformanceMetricsV3_secondary
object
Percentage of Shared Responsibility calls within the performance thresholds. Mandatory for data holders designated for a Shared Responsibility Data Request dat…
2 properties
2 required
PerformanceMetricsV3
object
Percentage of calls within the performance thresholds in each performance tier, over time.
8 properties
5 required
AuthorisationMetricsV2_newAuthorisationCount
object
The number of new authorisations.
2 properties
Meta
object
AuthorisationMetricsV2_abandonmentsByStage_failedTokenExchange
object
The number of authorisations that completed the interactive flow with the consumer authorising the consent, but the ADR failed to - or was unable to - obtain a…
2 properties
PerformanceMetricsV3_secondary_secondary
object
Percentage of Shared Responsibility calls within the performance thresholds for the secondary data holder.
2 properties
AverageResponseMetricsV2_highPriority
object
Average response time for the high priority tier.
2 properties
AuthorisationMetricsV2_newAuthorisationCount_currentDay_onceOff
object
New authorisation count for once-off authorisations.
2 properties
2 required
AuthorisationMetricsV2_revokedAuthorisationCount_currentDay
object
Number of revoked authorisations for the current day.
2 properties
2 required
PerformanceMetricsV3_largePayload
object
Percentage of large payload calls within the performance thresholds.
2 properties
AverageResponseMetricsV2_secondary_primary
object
Average response time as measured for the primary data holder.
2 properties
ErrorMetricsV2_unauthenticated
object
Number of calls resulting in error for unauthenticated endpoints.
2 properties
InvocationMetricsV3_unattended
object
API call counts for the unattended tier.
2 properties
SecondaryHolderMetricsV2_errors
object
Number of calls resulting in error due to server execution, over time.
2 properties
InvocationMetricsV3_largePayload
object
API call counts for the large payload tier.
2 properties
PerformanceMetricsV3_secondary_primary
object
Percentage of Shared Responsibility calls within the performance thresholds for the primary data holder.
2 properties
AuthorisationMetricsV2_newAuthorisationCount_currentDay
object
Number of new authorisations for the current day.
2 properties
2 required
AuthorisationMetricsV2_revokedAuthorisationCount_previousDays
object
2 properties
2 required
AuthorisationMetricsV2_expiredAuthorisationCount
object
The number of expired ongoing authorisations.
2 properties
PerformanceMetricsV3_largeSecondary
object
Percentage of large Shared Responsibility calls within the performance thresholds. Mandatory for data holders designated for a Shared Responsibility Data Reque…
2 properties
2 required
PeakTPSMetricsV2_unauthenticated
object
Peak transactions per second, over time, for unauthenticated endpoints.
2 properties
AuthorisationMetricsV2_abandonmentsByStage_preAccountSelection
object
The number of authorisations where the customer successfully authenticated with a valid OTP or equivalent but abandoned the process before selecting accounts.
2 properties
AvailabilityMetricsV2_aggregate
object
Aggregated availability metrics.
2 properties
AuthorisationMetricsV2_abandonmentsByStage_preAuthorisation
object
The number of authorisations where the customer has passed the account selection step but abandoned the process before approving or rejecting the consent being…
2 properties
Links
object
1 property
1 required
AverageResponseMetricsV2_lowPriority
object
Average response time for the low priority tier.
2 properties
PerformanceMetricsV3_highPriority
object
Percentage of high priority calls within the performance thresholds.
2 properties
AverageTPSMetricsV2_unauthenticated
object
Average transactions per second, over time, for unauthenticated endpoints.
2 properties
AuthorisationMetricsV2_activeAuthorisationCount
object
The number of active ongoing authorisations.
2 properties
2 required
RejectionMetricsV3_unauthenticated
object
Rejection counts for all unauthenticated endpoints.
2 properties
AuthorisationMetricsV2_newAuthorisationCount_currentDay_ongoing
object
New authorisation count for ongoing authorisations.
2 properties
2 required
RequestMetaDataUpdateV1
object
2 properties
1 required
AuthorisationMetricsV2_newAuthorisationCount_previousDays
object
2 properties
2 required
RejectionMetricsV3
object
Number of calls rejected due to traffic thresholds, over time.
2 properties
2 required
SecondaryHolderMetricsV2
object
Errors and rejections received by the primary data holder from the secondary data holder. Mandatory for data holders designated for a Shared Responsibility Dat…
2 properties
2 required
PerformanceMetricsV3_unattended
object
Percentage of unattended calls within the performance thresholds.
2 properties
ErrorMetricsV2_aggregate
object
Aggregate number of calls resulting in error due to server execution, over time, for all endpoints.
2 properties
AuthorisationMetricsV2_expiredAuthorisationCount_currentDay
object
Number of expired authorisations for the current day.
2 properties
2 required
AverageResponseMetricsV2_unauthenticated
object
Average response time for the unauthenticated tier.
2 properties
AuthorisationMetricsV2_amendedAuthorisationCount
object
The number of amended ongoing authorisations.
2 properties
AuthorisationMetricsV2_abandonedConsentFlowCount
object
The number of consents flows that were not successfully authorised.
2 properties
AuthorisationMetricsV2_abandonmentsByStage_preIdentification
object
The number of authorisations that commenced with the data holder but the customer did not successfully identify their profile or user ID.
2 properties
SessionCountMetricsV2
object
Session counts, over time. Note that a session is defined as the provisioning of an Access Token.
2 properties
PerformanceMetricsV3_aggregate
object
Percentage of calls within Primary Data Holder performance thresholds. Note that Secondary Data Holder performance MUST be excluded from this metric.
2 properties
AverageResponseMetricsV2_largePayload
object
Average response time for the large payload tier.
2 properties
PerformancePreviousDays
array
Array of contiguous hourly metrics for the specified day. Each element represents a 1 hour period starting from 12am-1am. Timezone for determining 12am must be…
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Consumer Data Right (Energy) 12
Other APIs Consumer Data Right (Energy) publishes across the network.
Consumer Data Right (Energy) Data Holder Client Registration API
Consumer Data Right (Energy) Data Holder Customers API
Consumer Data Right (Energy) Data Holder Operations API
Consumer Data Right (Energy) Distributed Energy Resources API
Consumer Data Right (Energy) Distributed Energy Resources (SR) API
Consumer Data Right (Energy) Electricity Service Points API
Consumer Data Right (Energy) Electricity Service Points (SR) API
Consumer Data Right (Energy) Electricity Usage API
Consumer Data Right (Energy) Electricity Usage (SR) API
Consumer Data Right (Energy) Energy Account Balances API
Consumer Data Right (Energy) Energy Account Billing API
Consumer Data Right (Energy) Energy Accounts API
#Data Holder Admin
Where this information came from
This is an independent, third-party profile of Consumer Data Right (Energy) Data Holder Admin API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.