openapi: 3.0.3
info:
contact:
email: contact@consumerdatastandards.gov.au
name: Consumer Data Standards Administration End Points
url: https://consumerdatastandards.gov.au
description: Data Holder Consumer Data Standards Administration End Points created
by the Data Standards Body (DSB), with the Data Standards Chair as the decision
maker
license:
name: MIT License
url: https://opensource.org/licenses/MIT
title: CDR Admin API
version: 1.30.0
servers:
- url: https://data.holder.com.au/cds-au/v1
paths:
/admin/register/metadata:
post:
description: Indicate that a critical update to the metadata for Accredited
Data Recipients has been made and should be obtained
operationId: metadataUpdate
parameters:
- description: Version of the API end point requested by the client. Must be
set to a positive integer. The data holder should respond with the highest
supported version between [x-min-v](#request-headers) and [x-v](#request-headers).
If the value of [x-min-v](#request-headers) is equal to or higher than the
value of [x-v](#request-headers) then the [x-min-v](#request-headers) header
should be treated as absent. If all versions requested are not supported
then the data holder should respond with a 406 Not Acceptable. See [HTTP
Headers](#request-headers)
explode: false
in: header
name: x-v
required: true
schema:
type: string
style: simple
- description: Minimum version of the API end point requested by the client.
Must be set to a positive integer if provided. The data holder should respond
with the highest supported version between [x-min-v](#request-headers) and
[x-v](#request-headers). If all versions requested are not supported then
the data holder should respond with a 406 Not Acceptable.
explode: false
in: header
name: x-min-v
required: false
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestMetaDataUpdate'
required: true
responses:
"200":
content:
application/json:
schema: {}
description: Success
headers:
x-v:
description: The [version](#response-headers) of the API end point that
the data holder has responded with.
explode: false
schema:
type: string
style: simple
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [400
- Invalid Field](#error-400-field-invalid)
- [400 - Missing Field](#error-400-field-missing)
- [400
- Invalid Version](#error-400-header-invalid-version)
"406":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [406
- Unsupported Version](#error-406-header-unsupported-version)
summary: Metadata Update
tags:
- Admin
- Register
x-scopes:
- admin:metadata:update
x-restricted-access: REGISTER
x-version: "1"
x-codegen-request-body-name: action
/admin/metrics:
get:
description: |-
This end point allows the ACCC to obtain operational statistics from the Data Holder (at the Data Holder Brand level) on the operation of their CDR compliant implementation. The statistics obtainable from this end point are determined by the non-functional requirements for the CDR regime.
This end point is not required to be implemented by the Australian Energy Market Operator, the Australian Energy Regulator or the Department of State administered by the Minister of Victoria administering the National Electricity (Victoria) Act 2005 (Vic).
NOTE: This version **MUST** be implemented by **May 13th 2024**
Obsolete versions: [v1](includes/obsolete/get-metrics-v1.html) [v2](includes/obsolete/get-metrics-v2.html).
Deprecated versions:
- [v3](includes/obsolete/get-metrics-v3.html) - Implementation not required for Data Holders going live on, or after, 1st November 2023. Other Data Holders **MAY** retire this version from the earlier of **13th May 2024** or from the time the ACCC announce that they no longer call this version
- [v4](includes/obsolete/get-metrics-v4.html) - This version, or v5, **MUST** be implemented by **November 1st 2023**
If the Data Holder supports private_key_jwt client authentication they MUST validate the scope.
operationId: getMetrics
parameters:
- description: The period of metrics to be requested. Values can be CURRENT
(meaning metrics for current period, dependent on the metric type), HISTORIC
(meaning metrics for previous period, depending on the metric type) or ALL.
If absent the default is ALL.
explode: true
in: query
name: period
required: false
schema:
default: ALL
enum:
- CURRENT
- HISTORIC
- ALL
type: string
style: form
- description: Version of the API end point requested by the client. Must be
set to a positive integer. The data holder should respond with the highest
supported version between [x-min-v](#request-headers) and [x-v](#request-headers).
If the value of [x-min-v](#request-headers) is equal to or higher than the
value of [x-v](#request-headers) then the [x-min-v](#request-headers) header
should be treated as absent. If all versions requested are not supported
then the data holder should respond with a 406 Not Acceptable. See [HTTP
Headers](#request-headers)
explode: false
in: header
name: x-v
required: true
schema:
type: string
style: simple
- description: Minimum version of the API end point requested by the client.
Must be set to a positive integer if provided. The data holder should respond
with the highest supported version between [x-min-v](#request-headers) and
[x-v](#request-headers). If all versions requested are not supported then
the data holder should respond with a 406 Not Acceptable.
explode: false
in: header
name: x-min-v
required: false
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseMetricsListV5'
description: Success
headers:
x-v:
description: The [version](#response-headers) of the API end point that
the data holder has responded with.
explode: false
schema:
type: string
style: simple
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [400
- Invalid Field](#error-400-field-invalid)
- [400 - Missing Field](#error-400-field-missing)
- [400
- Invalid Version](#error-400-header-invalid-version)
"406":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [406
- Unsupported Version](#error-406-header-unsupported-version)
summary: Get Metrics
tags:
- Admin
- Metrics
x-scopes:
- admin:metrics.basic:read
x-restricted-access: REGISTER
x-version: "5"
components:
parameters:
RequestHeader_x-v:
description: Version of the API end point requested by the client. Must be set
to a positive integer. The data holder should respond with the highest supported
version between [x-min-v](#request-headers) and [x-v](#request-headers). If
the value of [x-min-v](#request-headers) is equal to or higher than the value
of [x-v](#request-headers) then the [x-min-v](#request-headers) header should
be treated as absent. If all versions requested are not supported then the
data holder should respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)
explode: false
in: header
name: x-v
required: true
schema:
type: string
style: simple
RequestHeader_x-min-v:
description: Minimum version of the API end point requested by the client. Must
be set to a positive integer if provided. The data holder should respond with
the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers).
If all versions requested are not supported then the data holder should respond
with a 406 Not Acceptable.
explode: false
in: header
name: x-min-v
required: false
schema:
type: string
style: simple
schemas:
RequestMetaDataUpdate:
example:
data:
action: REFRESH
meta: '{}'
properties:
data:
$ref: '#/components/schemas/RequestMetaDataUpdate_data'
meta:
type: object
required:
- data
type: object
ResponseMetricsListV5:
example:
data:
rejections:
authenticated:
previousDays:
- 4
- 4
currentDay: 3
unauthenticated:
previousDays:
- 6
- 6
currentDay: 0
peakTps:
authenticated:
previousDays:
- 4.652396432933246
- 4.652396432933246
currentDay: 0.10263654006109402
unauthenticated:
previousDays:
- 6.519180951018382
- 6.519180951018382
currentDay: 7.058770351582356
aggregate:
previousDays:
- 0.8851374739011653
- 0.8851374739011653
currentDay: 7.143538047012306
averageTps:
authenticated:
previousDays:
- 3.0937452626664474
- 3.0937452626664474
currentDay: 3.353193347011243
unauthenticated:
previousDays:
- 6.704019297950036
- 6.704019297950036
currentDay: 5.944895607614016
aggregate:
previousDays:
- 6.878052220127876
- 6.878052220127876
currentDay: 6.778324963048013
secondaryHolder:
rejections:
previousDays:
- 0
- 0
currentDay: 9
errors:
previousDays:
- 7
- 7
currentDay: 4
availability:
authenticated:
previousMonths:
- previousMonths
- previousMonths
currentMonth: currentMonth
unauthenticated:
previousMonths:
- previousMonths
- previousMonths
currentMonth: currentMonth
aggregate:
previousMonths:
- previousMonths
- previousMonths
currentMonth: currentMonth
averageResponse:
unattended:
previousDays:
- 9.369310271410669
- 9.369310271410669
currentDay: 9.965781217890562
secondary:
secondary:
previousDays:
- 6.965117697638846
- 6.965117697638846
currentDay: 3.5571952270680973
primary:
previousDays:
- 6.438423552598547
- 6.438423552598547
currentDay: 9.018348186070783
highPriority:
previousDays:
- 1.1730742509559433
- 1.1730742509559433
currentDay: 7.457744773683766
largePayload:
previousDays:
- 8.762042012749001
- 8.762042012749001
currentDay: 6.683562403749608
unauthenticated:
previousDays:
- 6.84685269835264
- 6.84685269835264
currentDay: 1.4894159098541704
lowPriority:
previousDays:
- 5.025004791520295
- 5.025004791520295
currentDay: 4.965218492984954
largeSecondary:
secondary:
previousDays:
- 6.965117697638846
- 6.965117697638846
currentDay: 3.5571952270680973
primary:
previousDays:
- 6.438423552598547
- 6.438423552598547
currentDay: 9.018348186070783
invocations:
unattended:
previousDays:
- 9
- 9
currentDay: 7
secondary:
previousDays:
- 7
- 7
currentDay: 4
highPriority:
previousDays:
- 5
- 5
currentDay: 1
largePayload:
previousDays:
- 2
- 2
currentDay: 3
unauthenticated:
previousDays:
- 6
- 6
currentDay: 0
lowPriority:
previousDays:
- 2
- 2
currentDay: 5
largeSecondary:
previousDays:
- 1
- 1
currentDay: 1
requestTime: requestTime
performance:
unattended:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
secondary:
secondary:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
primary:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
highPriority:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
largePayload:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
unauthenticated:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
lowPriority:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
aggregate:
previousDays:
- previousDays
- previousDays
currentDay: currentDay
largeSecondary:
secondary:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
primary:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
sessionCount:
previousDays:
- 2
- 2
currentDay: 1
recipientCount: 1
authorisations:
abandonedConsentFlowCount:
previousDays:
- 9
- 9
currentDay: 3
newAuthorisationCount:
previousDays:
- ongoing:
nonIndividual: 6
individual: 4
onceOff:
nonIndividual: 5
individual: 7
- ongoing:
nonIndividual: 6
individual: 4
onceOff:
nonIndividual: 5
individual: 7
currentDay:
ongoing:
nonIndividual: 6
individual: 4
onceOff:
nonIndividual: 5
individual: 7
abandonmentsByStage:
preAuthorisation:
previousDays:
- 3
- 3
currentDay: 3
rejected:
previousDays:
- 5
- 5
currentDay: 9
preAccountSelection:
previousDays:
- 7
- 7
currentDay: 8
preIdentification:
previousDays:
- 0
- 0
currentDay: 8
failedTokenExchange:
previousDays:
- 0
- 0
currentDay: 7
preAuthentication:
previousDays:
- 5
- 5
currentDay: 5
amendedAuthorisationCount:
previousDays:
- nonIndividual: 6
individual: 8
- nonIndividual: 6
individual: 8
currentDay:
nonIndividual: 1
individual: 2
activeAuthorisationCount:
nonIndividual: 0
individual: 9
expiredAuthorisationCount:
previousDays:
- nonIndividual: 1
individual: 9
- nonIndividual: 1
individual: 9
currentDay:
nonIndividual: 8
individual: 4
revokedAuthorisationCount:
previousDays:
- nonIndividual: 0
individual: 3
- nonIndividual: 0
individual: 3
currentDay:
nonIndividual: 4
individual: 8
errors:
authenticated:
previousDays:
- key: 5
- key: 5
currentDay:
key: 7
unauthenticated:
previousDays:
- key: 3
- key: 3
currentDay:
key: 3
aggregate:
previousDays:
- 7
- 7
currentDay: 8
customerCount: 4
meta: '{}'
links:
self: self
properties:
data:
$ref: '#/components/schemas/ResponseMetricsListV5_data'
links:
$ref: '#/components/schemas/Links'
meta:
type: object
required:
- data
- links
type: object
AvailabilityMetricsV2:
description: Availability metrics
example:
authenticated:
previousMonths:
- previousMonths
- previousMonths
currentMonth: currentMonth
unauthenticated:
previousMonths:
- previousMonths
- previousMonths
currentMonth: currentMonth
aggregate:
previousMonths:
- previousMonths
- previousMonths
currentMonth: currentMonth
properties:
aggregate:
$ref: '#/components/schemas/AvailabilityMetricsV2_aggregate'
unauthenticated:
$ref: '#/components/schemas/AvailabilityMetricsV2_unauthenticated'
authenticated:
$ref: '#/components/schemas/AvailabilityMetricsV2_authenticated'
required:
- aggregate
- authenticated
- unauthenticated
type: object
PerformanceMetricsV3:
description: Percentage of calls within the performance thresholds in each performance
tier over time
example:
unattended:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
secondary:
secondary:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
primary:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
highPriority:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
largePayload:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
unauthenticated:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
lowPriority:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
aggregate:
previousDays:
- previousDays
- previousDays
currentDay: currentDay
largeSecondary:
secondary:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
primary:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
properties:
aggregate:
$ref: '#/components/schemas/PerformanceMetricsV3_aggregate'
highPriority:
$ref: '#/components/schemas/PerformanceMetricsV3_highPriority'
largePayload:
$ref: '#/components/schemas/PerformanceMetricsV3_largePayload'
lowPriority:
$ref: '#/components/schemas/PerformanceMetricsV3_lowPriority'
unattended:
$ref: '#/components/schemas/PerformanceMetricsV3_unattended'
unauthenticated:
$ref: '#/components/schemas/PerformanceMetricsV3_unauthenticated'
secondary:
$ref: '#/components/schemas/PerformanceMetricsV3_secondary'
largeSecondary:
$ref: '#/components/schemas/PerformanceMetricsV3_largeSecondary'
required:
- highPriority
- largePayload
- lowPriority
- unattended
- unauthenticated
type: object
x-conditional:
- secondary
- largeSecondary
InvocationMetricsV3:
description: Number of API calls in each performance tier over time
example:
unattended:
previousDays:
- 9
- 9
currentDay: 7
secondary:
previousDays:
- 7
- 7
currentDay: 4
highPriority:
previousDays:
- 5
- 5
currentDay: 1
largePayload:
previousDays:
- 2
- 2
currentDay: 3
unauthenticated:
previousDays:
- 6
- 6
currentDay: 0
lowPriority:
previousDays:
- 2
- 2
currentDay: 5
largeSecondary:
previousDays:
- 1
- 1
currentDay: 1
properties:
unauthenticated:
$ref: '#/components/schemas/InvocationMetricsV3_unauthenticated'
highPriority:
$ref: '#/components/schemas/InvocationMetricsV3_highPriority'
lowPriority:
$ref: '#/components/schemas/InvocationMetricsV3_lowPriority'
unattended:
$ref: '#/components/schemas/InvocationMetricsV3_unattended'
largePayload:
$ref: '#/components/schemas/InvocationMetricsV3_largePayload'
secondary:
$ref: '#/components/schemas/InvocationMetricsV3_secondary'
largeSecondary:
$ref: '#/components/schemas/InvocationMetricsV3_largeSecondary'
required:
- highPriority
- largePayload
- lowPriority
- unattended
- unauthenticated
type: object
x-conditional:
- secondary
- largeSecondary
AverageResponseMetricsV2:
description: Average response time in seconds, at millisecond resolution, within
each performance tier
example:
unattended:
previousDays:
- 9.369310271410669
- 9.369310271410669
currentDay: 9.965781217890562
secondary:
secondary:
previousDays:
- 6.965117697638846
- 6.965117697638846
currentDay: 3.5571952270680973
primary:
previousDays:
- 6.438423552598547
- 6.438423552598547
currentDay: 9.018348186070783
highPriority:
previousDays:
- 1.1730742509559433
- 1.1730742509559433
currentDay: 7.457744773683766
largePayload:
previousDays:
- 8.762042012749001
- 8.762042012749001
currentDay: 6.683562403749608
unauthenticated:
previousDays:
- 6.84685269835264
- 6.84685269835264
currentDay: 1.4894159098541704
lowPriority:
previousDays:
- 5.025004791520295
- 5.025004791520295
currentDay: 4.965218492984954
largeSecondary:
secondary:
previousDays:
- 6.965117697638846
- 6.965117697638846
currentDay: 3.5571952270680973
primary:
previousDays:
- 6.438423552598547
- 6.438423552598547
currentDay: 9.018348186070783
properties:
unauthenticated:
$ref: '#/components/schemas/AverageResponseMetricsV2_unauthenticated'
highPriority:
$ref: '#/components/schemas/AverageResponseMetricsV2_highPriority'
lowPriority:
$ref: '#/components/schemas/AverageResponseMetricsV2_lowPriority'
unattended:
$ref: '#/components/schemas/AverageResponseMetricsV2_unattended'
largePayload:
$ref: '#/components/schemas/AverageResponseMetricsV2_largePayload'
secondary:
$ref: '#/components/schemas/AverageResponseMetricsV2_secondary'
largeSecondary:
$ref: '#/components/schemas/AverageResponseMetricsV2_largeSecondary'
required:
- highPriority
- largePayload
- lowPriority
- unattended
- unauthenticated
type: object
x-conditional:
- secondary
- largeSecondary
SessionCountMetricsV2:
description: Session counts over time. Note that a session is defined as the
provisioning of an Access Token.
example:
previousDays:
- 2
- 2
currentDay: 1
properties:
currentDay:
description: Session count for current day
type: integer
x-cds-type: NaturalNumber
previousDays:
description: Session count for previous days. The first element indicates
yesterday and so on. A maximum of seven entries is required if available
items:
type: integer
x-cds-type: NaturalNumber
type: array
type: object
x-conditional:
- currentDay
- previousDays
AverageTPSMetricsV2:
description: Average transactions per second over time
example:
authenticated:
previousDays:
- 3.0937452626664474
- 3.0937452626664474
currentDay: 3.353193347011243
unauthenticated:
previousDays:
- 6.704019297950036
- 6.704019297950036
currentDay: 5.944895607614016
aggregate:
previousDays:
- 6.878052220127876
- 6.878052220127876
currentDay: 6.778324963048013
properties:
aggregate:
$ref: '#/components/schemas/AverageTPSMetricsV2_aggregate'
unauthenticated:
$ref: '#/components/schemas/AverageTPSMetricsV2_unauthenticated'
authenticated:
$ref: '#/components/schemas/AverageTPSMetricsV2_authenticated'
required:
- aggregate
- authenticated
- unauthenticated
type: object
PeakTPSMetricsV2:
description: Peak transactions per second over time
example:
authenticated:
previousDays:
- 4.652396432933246
- 4.652396432933246
currentDay: 0.10263654006109402
unauthenticated:
previousDays:
- 6.519180951018382
- 6.519180951018382
currentDay: 7.058770351582356
aggregate:
previousDays:
- 0.8851374739011653
- 0.8851374739011653
currentDay: 7.143538047012306
properties:
aggregate:
$ref: '#/components/schemas/PeakTPSMetricsV2_aggregate'
unauthenticated:
$ref: '#/components/schemas/PeakTPSMetricsV2_unauthenticated'
authenticated:
$ref: '#/components/schemas/PeakTPSMetricsV2_authenticated'
required:
- aggregate
- authenticated
- unauthenticated
type: object
ErrorMetricsV2:
description: Number of calls resulting in error, over time
example:
authenticated:
previousDays:
- key: 5
- key: 5
currentDay:
key: 7
unauthenticated:
previousDays:
- key: 3
- key: 3
currentDay:
key: 3
aggregate:
previousDays:
- 7
- 7
currentDay: 8
properties:
aggregate:
$ref: '#/components/schemas/ErrorMetricsV2_aggregate'
unauthenticated:
$ref: '#/components/schemas/ErrorMetricsV2_unauthenticated'
authenticated:
$ref: '#/components/schemas/ErrorMetricsV2_authenticated'
required:
- aggregate
- authenticated
- unauthenticated
type: object
RejectionMetricsV3:
description: Number of calls rejected due to traffic thresholds over time
example:
authenticated:
previousDays:
- 4
- 4
currentDay: 3
unauthenticated:
previousDays:
- 6
- 6
currentDay: 0
properties:
authenticated:
$ref: '#/components/schemas/RejectionMetricsV3_authenticated'
unauthenticated:
$ref: '#/components/schemas/RejectionMetricsV3_unauthenticated'
required:
- authenticated
- unauthenticated
type: object
SecondaryHolderMetricsV2:
description: Errors and rejections received by the primary data holder from
the secondary data holder. Mandatory for data holders designated for a Shared
Responsibility Data Request data cluster
example:
rejections:
previousDays:
- 0
- 0
currentDay: 9
errors:
previousDays:
- 7
- 7
currentDay: 4
properties:
errors:
$ref: '#/components/schemas/SecondaryHolderMetricsV2_errors'
rejections:
$ref: '#/components/schemas/SecondaryHolderMetricsV2_rejections'
required:
- errors
- rejections
type: object
AuthorisationMetricsV2:
description: Authorisation counts for the data holder
example:
abandonedConsentFlowCount:
previousDays:
- 9
- 9
currentDay: 3
newAuthorisationCount:
previousDays:
- ongoing:
nonIndividual: 6
individual: 4
onceOff:
nonIndividual: 5
individual: 7
- ongoing:
nonIndividual: 6
individual: 4
onceOff:
nonIndividual: 5
individual: 7
currentDay:
ongoing:
nonIndividual: 6
individual: 4
onceOff:
nonIndividual: 5
individual: 7
abandonmentsByStage:
preAuthorisation:
previousDays:
- 3
- 3
currentDay: 3
rejected:
previousDays:
- 5
- 5
currentDay: 9
preAccountSelection:
previousDays:
- 7
- 7
currentDay: 8
preIdentification:
previousDays:
- 0
- 0
currentDay: 8
failedTokenExchange:
previousDays:
- 0
- 0
currentDay: 7
preAuthentication:
previousDays:
- 5
- 5
currentDay: 5
amendedAuthorisationCount:
previousDays:
- nonIndividual: 6
individual: 8
- nonIndividual: 6
individual: 8
currentDay:
nonIndividual: 1
individual: 2
activeAuthorisationCount:
nonIndividual: 0
individual: 9
expiredAuthorisationCount:
previousDays:
- nonIndividual: 1
individual: 9
- nonIndividual: 1
individual: 9
currentDay:
nonIndividual: 8
individual: 4
revokedAuthorisationCount:
previousDays:
- nonIndividual: 0
individual: 3
- nonIndividual: 0
individual: 3
currentDay:
nonIndividual: 4
individual: 8
properties:
activeAuthorisationCount:
$ref: '#/components/schemas/AuthorisationMetricsV2_activeAuthorisationCount'
newAuthorisationCount:
$ref: '#/components/schemas/AuthorisationMetricsV2_newAuthorisationCount'
revokedAuthorisationCount:
$ref: '#/components/schemas/AuthorisationMetricsV2_revokedAuthorisationCount'
amendedAuthorisationCount:
$ref: '#/components/schemas/AuthorisationMetricsV2_amendedAuthorisationCount'
expiredAuthorisationCount:
$ref: '#/components/schemas/AuthorisationMetricsV2_expiredAuthorisationCount'
abandonedConsentFlowCount:
$ref: '#/components/schemas/AuthorisationMetricsV2_abandonedConsentFlowCount'
abandonmentsByStage:
$ref: '#/components/schemas/AuthorisationMetricsV2_abandonmentsByStage'
required:
- abandonedConsentFlowCount
- abandonmentsByStage
- activeAuthorisationCount
- amendedAuthorisationCount
- expiredAuthorisationCount
- newAuthorisationCount
- revokedAuthorisationCount
type: object
Links:
example:
self: self
properties:
self:
description: Fully qualified link to this API call
type: string
x-cds-type: URIString
required:
- self
type: object
Meta:
type: object
MetaError:
description: Additional data for customised error codes
properties:
urn:
description: The CDR error code URN which the application-specific error
code extends. Mandatory if the error `code` is an application-specific
error rather than a standardised error code.
type: string
type: object
x-conditional:
- urn
ResponseErrorListV2:
properties:
errors:
items:
$ref: '#/components/schemas/ResponseErrorListV2_errors'
type: array
required:
- errors
type: object
x-conditional:
- meta
RequestMetaDataUpdate_data:
example:
action: REFRESH
properties:
action:
default: REFRESH
description: The action to take for the meta data. At the moment the only
option is REFRESH which requires the data holder to call the ACCC to refresh
meta data as soon as practicable
enum:
- REFRESH
type: string
required:
- action
type: object
ResponseMetricsListV5_data:
example:
rejections:
authenticated:
previousDays:
- 4
- 4
currentDay: 3
unauthenticated:
previousDays:
- 6
- 6
currentDay: 0
peakTps:
authenticated:
previousDays:
- 4.652396432933246
- 4.652396432933246
currentDay: 0.10263654006109402
unauthenticated:
previousDays:
- 6.519180951018382
- 6.519180951018382
currentDay: 7.058770351582356
aggregate:
previousDays:
- 0.8851374739011653
- 0.8851374739011653
currentDay: 7.143538047012306
averageTps:
authenticated:
previousDays:
- 3.0937452626664474
- 3.0937452626664474
currentDay: 3.353193347011243
unauthenticated:
previousDays:
- 6.704019297950036
- 6.704019297950036
currentDay: 5.944895607614016
aggregate:
previousDays:
- 6.878052220127876
- 6.878052220127876
currentDay: 6.778324963048013
secondaryHolder:
rejections:
previousDays:
- 0
- 0
currentDay: 9
errors:
previousDays:
- 7
- 7
currentDay: 4
availability:
authenticated:
previousMonths:
- previousMonths
- previousMonths
currentMonth: currentMonth
unauthenticated:
previousMonths:
- previousMonths
- previousMonths
currentMonth: currentMonth
aggregate:
previousMonths:
- previousMonths
- previousMonths
currentMonth: currentMonth
averageResponse:
unattended:
previousDays:
- 9.369310271410669
- 9.369310271410669
currentDay: 9.965781217890562
secondary:
secondary:
previousDays:
- 6.965117697638846
- 6.965117697638846
currentDay: 3.5571952270680973
primary:
previousDays:
- 6.438423552598547
- 6.438423552598547
currentDay: 9.018348186070783
highPriority:
previousDays:
- 1.1730742509559433
- 1.1730742509559433
currentDay: 7.457744773683766
largePayload:
previousDays:
- 8.762042012749001
- 8.762042012749001
currentDay: 6.683562403749608
unauthenticated:
previousDays:
- 6.84685269835264
- 6.84685269835264
currentDay: 1.4894159098541704
lowPriority:
previousDays:
- 5.025004791520295
- 5.025004791520295
currentDay: 4.965218492984954
largeSecondary:
secondary:
previousDays:
- 6.965117697638846
- 6.965117697638846
currentDay: 3.5571952270680973
primary:
previousDays:
- 6.438423552598547
- 6.438423552598547
currentDay: 9.018348186070783
invocations:
unattended:
previousDays:
- 9
- 9
currentDay: 7
secondary:
previousDays:
- 7
- 7
currentDay: 4
highPriority:
previousDays:
- 5
- 5
currentDay: 1
largePayload:
previousDays:
- 2
- 2
currentDay: 3
unauthenticated:
previousDays:
- 6
- 6
currentDay: 0
lowPriority:
previousDays:
- 2
- 2
currentDay: 5
largeSecondary:
previousDays:
- 1
- 1
currentDay: 1
requestTime: requestTime
performance:
unattended:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
secondary:
secondary:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
primary:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
highPriority:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
largePayload:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
unauthenticated:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
lowPriority:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
aggregate:
previousDays:
- previousDays
- previousDays
currentDay: currentDay
largeSecondary:
secondary:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
primary:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
sessionCount:
previousDays:
- 2
- 2
currentDay: 1
recipientCount: 1
authorisations:
abandonedConsentFlowCount:
previousDays:
- 9
- 9
currentDay: 3
newAuthorisationCount:
previousDays:
- ongoing:
nonIndividual: 6
individual: 4
onceOff:
nonIndividual: 5
individual: 7
- ongoing:
nonIndividual: 6
individual: 4
onceOff:
nonIndividual: 5
individual: 7
currentDay:
ongoing:
nonIndividual: 6
individual: 4
onceOff:
nonIndividual: 5
individual: 7
abandonmentsByStage:
preAuthorisation:
previousDays:
- 3
- 3
currentDay: 3
rejected:
previousDays:
- 5
- 5
currentDay: 9
preAccountSelection:
previousDays:
- 7
- 7
currentDay: 8
preIdentification:
previousDays:
- 0
- 0
currentDay: 8
failedTokenExchange:
previousDays:
- 0
- 0
currentDay: 7
preAuthentication:
previousDays:
- 5
- 5
currentDay: 5
amendedAuthorisationCount:
previousDays:
- nonIndividual: 6
individual: 8
- nonIndividual: 6
individual: 8
currentDay:
nonIndividual: 1
individual: 2
activeAuthorisationCount:
nonIndividual: 0
individual: 9
expiredAuthorisationCount:
previousDays:
- nonIndividual: 1
individual: 9
- nonIndividual: 1
individual: 9
currentDay:
nonIndividual: 8
individual: 4
revokedAuthorisationCount:
previousDays:
- nonIndividual: 0
individual: 3
- nonIndividual: 0
individual: 3
currentDay:
nonIndividual: 4
individual: 8
errors:
authenticated:
previousDays:
- key: 5
- key: 5
currentDay:
key: 7
unauthenticated:
previousDays:
- key: 3
- key: 3
currentDay:
key: 3
aggregate:
previousDays:
- 7
- 7
currentDay: 8
customerCount: 4
properties:
requestTime:
description: The date and time that the metrics in this payload were requested.
type: string
x-cds-type: DateTimeString
availability:
$ref: '#/components/schemas/AvailabilityMetricsV2'
performance:
$ref: '#/components/schemas/PerformanceMetricsV3'
invocations:
$ref: '#/components/schemas/InvocationMetricsV3'
averageResponse:
$ref: '#/components/schemas/AverageResponseMetricsV2'
sessionCount:
$ref: '#/components/schemas/SessionCountMetricsV2'
averageTps:
$ref: '#/components/schemas/AverageTPSMetricsV2'
peakTps:
$ref: '#/components/schemas/PeakTPSMetricsV2'
errors:
$ref: '#/components/schemas/ErrorMetricsV2'
rejections:
$ref: '#/components/schemas/RejectionMetricsV3'
customerCount:
description: Number of customers with active authorisations at the time
of the call
type: integer
x-cds-type: NaturalNumber
recipientCount:
description: Number of Data Recipient Software Products with active authorisations
at the time of the call
type: integer
x-cds-type: NaturalNumber
secondaryHolder:
$ref: '#/components/schemas/SecondaryHolderMetricsV2'
authorisations:
$ref: '#/components/schemas/AuthorisationMetricsV2'
required:
- authorisations
- availability
- averageResponse
- averageTps
- customerCount
- errors
- invocations
- peakTps
- performance
- recipientCount
- rejections
- requestTime
- sessionCount
type: object
x-conditional:
- secondaryHolder
AvailabilityMetricsV2_aggregate:
description: Aggregated availability metrics
example:
previousMonths:
- previousMonths
- previousMonths
currentMonth: currentMonth
properties:
currentMonth:
description: Percentage availability of the CDR platform so far for the
current calendar month. 0.0 means 0%. 1.0 means 100%. Must be a positive
value or zero
type: string
x-cds-type: RateString
previousMonths:
description: Percentage availability of the CDR platform for previous calendar
months. The first element indicates the last month and so on. A maximum
of twelve entries is required if available. 0.0 means 0%. 1.0 means 100%.
Values must be a positive or zero
items:
type: string
x-cds-type: RateString
type: array
type: object
x-conditional:
- currentMonth
- previousMonths
AvailabilityMetricsV2_unauthenticated:
description: Availability metrics for the unauthenticated aspects of the CDR
regime
example:
previousMonths:
- previousMonths
- previousMonths
currentMonth: currentMonth
properties:
currentMonth:
description: Percentage availability of the CDR platform so far for the
current calendar month. 0.0 means 0%. 1.0 means 100%. Must be a positive
value or zero
type: string
x-cds-type: RateString
previousMonths:
description: Percentage availability of the CDR platform for previous calendar
months. The first element indicates the last month and so on. A maximum
of twelve entries is required if available. 0.0 means 0%. 1.0 means 100%.
Values must be a positive or zero
items:
type: string
x-cds-type: RateString
type: array
type: object
x-conditional:
- currentMonth
- previousMonths
AvailabilityMetricsV2_authenticated:
description: Availability metrics for the authenticated aspects of the CDR regime
example:
previousMonths:
- previousMonths
- previousMonths
currentMonth: currentMonth
properties:
currentMonth:
description: Percentage availability of the CDR platform so far for the
current calendar month. 0.0 means 0%. 1.0 means 100%. Must be a positive
value or zero
type: string
x-cds-type: RateString
previousMonths:
description: Percentage availability of the CDR platform for previous calendar
months. The first element indicates the last month and so on. A maximum
of twelve entries is required if available. 0.0 means 0%. 1.0 means 100%.
Values must be a positive or zero
items:
type: string
x-cds-type: RateString
type: array
type: object
x-conditional:
- currentMonth
- previousMonths
PerformanceMetricsV3_aggregate:
description: Percentage of calls within Primary Data Holder performance thresholds.
Note that Secondary Data Holder performance MUST be excluded from this
metric.
example:
previousDays:
- previousDays
- previousDays
currentDay: currentDay
properties:
currentDay:
description: Percentage of calls within the performance threshold for the
current day. 0.0 means 0%. 1.0 means 100%. Must be a positive value or
zero
type: string
x-cds-type: RateString
previousDays:
description: Percentage of calls within the performance threshold for previous
days. The first element indicates yesterday and so on. A maximum of seven
entries is required if available. 0.0 means 0%. 1.0 means 100%. Values
must be a positive or zero
items:
type: string
x-cds-type: RateString
type: array
type: object
x-conditional:
- currentDay
- previousDays
PerformanceMetricsV3_highPriority:
description: Percentage of high priority calls within the performance thresholds
example:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
properties:
currentDay:
description: Array of contiguous hourly metrics for the current day. Each
element represents a 1 hour period starting from 12am-1am. Timezone for
determining 12am must be consistent but is at the discretion of the Data
Holder
items:
description: 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
type: string
x-cds-type: RateString
type: array
previousDays:
description: Percentage of calls within the performance threshold for previous
days. The first element indicates yesterday and so on. A maximum of seven
entries is required if available. 0.0 means 0%. 1.0 means 100%. Values
must be a positive or zero
items:
description: 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 consistent but is at the discretion of
the Data Holder
items:
description: 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
type: string
x-cds-type: RateString
type: array
type: array
type: object
x-conditional:
- currentDay
- previousDays
PerformanceMetricsV3_largePayload:
description: Percentage of large payload calls within the performance thresholds
example:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
properties:
currentDay:
description: Array of contiguous hourly metrics for the current day. Each
element represents a 1 hour period starting from 12am-1am. Timezone for
determining 12am must be consistent but is at the discretion of the Data
Holder
items:
description: 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
type: string
x-cds-type: RateString
type: array
previousDays:
description: Percentage of calls within the performance threshold for previous
days. The first element indicates yesterday and so on. A maximum of seven
entries is required if available. 0.0 means 0%. 1.0 means 100%. Values
must be a positive or zero
items:
description: 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 consistent but is at the discretion of
the Data Holder
items:
description: 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
type: string
x-cds-type: RateString
type: array
type: array
type: object
x-conditional:
- currentDay
- previousDays
PerformanceMetricsV3_lowPriority:
description: Percentage of low priority calls within the performance thresholds
example:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
properties:
currentDay:
description: Array of contiguous hourly metrics for the current day. Each
element represents a 1 hour period starting from 12am-1am. Timezone for
determining 12am must be consistent but is at the discretion of the Data
Holder
items:
description: 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
type: string
x-cds-type: RateString
type: array
previousDays:
description: Percentage of calls within the performance threshold for previous
days. The first element indicates yesterday and so on. A maximum of seven
entries is required if available. 0.0 means 0%. 1.0 means 100%. Values
must be a positive or zero
items:
description: 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 consistent but is at the discretion of
the Data Holder
items:
description: 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
type: string
x-cds-type: RateString
type: array
type: array
type: object
x-conditional:
- currentDay
- previousDays
PerformanceMetricsV3_unattended:
description: Percentage of unattended calls within the performance thresholds
example:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
properties:
currentDay:
description: Array of contiguous hourly metrics for the current day. Each
element represents a 1 hour period starting from 12am-1am. Timezone for
determining 12am must be consistent but is at the discretion of the Data
Holder
items:
description: 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
type: string
x-cds-type: RateString
type: array
previousDays:
description: Percentage of calls within the performance threshold for previous
days. The first element indicates yesterday and so on. A maximum of seven
entries is required if available. 0.0 means 0%. 1.0 means 100%. Values
must be a positive or zero
items:
description: 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 consistent but is at the discretion of
the Data Holder
items:
description: 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
type: string
x-cds-type: RateString
type: array
type: array
type: object
x-conditional:
- currentDay
- previousDays
PerformanceMetricsV3_unauthenticated:
description: Percentage of unauthenticated calls within the performance thresholds
example:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
properties:
currentDay:
description: Array of contiguous hourly metrics for the current day. Each
element represents a 1 hour period starting from 12am-1am. Timezone for
determining 12am must be consistent but is at the discretion of the Data
Holder
items:
description: 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
type: string
x-cds-type: RateString
type: array
previousDays:
description: Percentage of calls within the performance threshold for previous
days. The first element indicates yesterday and so on. A maximum of seven
entries is required if available. 0.0 means 0%. 1.0 means 100%. Values
must be a positive or zero
items:
description: 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 consistent but is at the discretion of
the Data Holder
items:
description: 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
type: string
x-cds-type: RateString
type: array
type: array
type: object
x-conditional:
- currentDay
- previousDays
PerformanceMetricsV3_secondary_primary:
description: Percentage of Shared Responsibility calls within the performance
thresholds for the primary data holder
example:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
properties:
currentDay:
description: Array of contiguous hourly metrics for the current day. Each
element represents a 1 hour period starting from 12am-1am. Timezone for
determining 12am must be consistent but is at the discretion of the Data
Holder
items:
description: 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
type: string
x-cds-type: RateString
type: array
previousDays:
description: Percentage of calls within the performance threshold for previous
days. The first element indicates yesterday and so on. A maximum of seven
entries is required if available. 0.0 means 0%. 1.0 means 100%. Values
must be a positive or zero
items:
description: 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 consistent but is at the discretion of
the Data Holder
items:
description: 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
type: string
x-cds-type: RateString
type: array
type: array
type: object
x-conditional:
- currentDay
- previousDays
PerformanceMetricsV3_secondary_secondary:
description: Percentage of Shared Responsibility calls within the performance
thresholds for the secondary data holder
example:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
properties:
currentDay:
description: Array of contiguous hourly metrics for the current day. Each
element represents a 1 hour period starting from 12am-1am. Timezone for
determining 12am must be consistent but is at the discretion of the Data
Holder
items:
description: 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
type: string
x-cds-type: RateString
type: array
previousDays:
description: Percentage of calls within the performance threshold for previous
days. The first element indicates yesterday and so on. A maximum of seven
entries is required if available. 0.0 means 0%. 1.0 means 100%. Values
must be a positive or zero
items:
description: 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 consistent but is at the discretion of
the Data Holder
items:
description: 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
type: string
x-cds-type: RateString
type: array
type: array
type: object
x-conditional:
- currentDay
- previousDays
PerformanceMetricsV3_secondary:
description: Percentage of Shared Responsibility calls within the performance
thresholds. Mandatory for data holders designated for a Shared Responsibility
Data Request data cluster
example:
secondary:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
primary:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
properties:
primary:
$ref: '#/components/schemas/PerformanceMetricsV3_secondary_primary'
secondary:
$ref: '#/components/schemas/PerformanceMetricsV3_secondary_secondary'
required:
- primary
- secondary
type: object
PerformanceMetricsV3_largeSecondary_primary:
description: Percentage of large Shared Responsibility calls within the performance
thresholds for the secondary data holder
example:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
properties:
currentDay:
description: Array of contiguous hourly metrics for the current day. Each
element represents a 1 hour period starting from 12am-1am. Timezone for
determining 12am must be consistent but is at the discretion of the Data
Holder
items:
description: 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
type: string
x-cds-type: RateString
type: array
previousDays:
description: Percentage of calls within the performance threshold for previous
days. The first element indicates yesterday and so on. A maximum of seven
entries is required if available. 0.0 means 0%. 1.0 means 100%. Values
must be a positive or zero
items:
description: 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 consistent but is at the discretion of
the Data Holder
items:
description: 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
type: string
x-cds-type: RateString
type: array
type: array
type: object
x-conditional:
- currentDay
- previousDays
PerformanceMetricsV3_largeSecondary:
description: Percentage of large Shared Responsibility calls within the performance
thresholds. Mandatory for data holders designated for a Shared Responsibility
Data Request data cluster
example:
secondary:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
primary:
previousDays:
- - previousDays
- previousDays
- - previousDays
- previousDays
currentDay:
- currentDay
- currentDay
properties:
primary:
$ref: '#/components/schemas/PerformanceMetricsV3_largeSecondary_primary'
secondary:
$ref: '#/components/schemas/PerformanceMetricsV3_largeSecondary_primary'
required:
- primary
- secondary
type: object
InvocationMetricsV3_unauthenticated:
description: API call counts for the unauthenticated tier
example:
previousDays:
- 6
- 6
currentDay: 0
properties:
currentDay:
description: API call counts for current day
type: integer
x-cds-type: NaturalNumber
previousDays:
description: API call counts for previous days. The first element indicates
yesterday and so on. A maximum of seven entries is required if available
items:
type: integer
x-cds-type: NaturalNumber
type: array
type: object
x-conditional:
- currentDay
- previousDays
InvocationMetricsV3_highPriority:
description: API call counts for the high priority tier
example:
previousDays:
- 5
- 5
currentDay: 1
properties:
currentDay:
description: API call counts for current day
type: integer
x-cds-type: NaturalNumber
previousDays:
description: API call counts for previous days. The first element indicates
yesterday and so on. A maximum of seven entries is required if available
items:
type: integer
x-cds-type: NaturalNumber
type: array
type: object
x-conditional:
- currentDay
- previousDays
InvocationMetricsV3_lowPriority:
description: API call counts for the low priority tier
example:
previousDays:
- 2
- 2
currentDay: 5
properties:
currentDay:
description: API call counts for current day
type: integer
x-cds-type: NaturalNumber
previousDays:
description: API call counts for previous days. The first element indicates
yesterday and so on. A maximum of seven entries is required if available
items:
type: integer
x-cds-type: NaturalNumber
type: array
type: object
x-conditional:
- currentDay
- previousDays
InvocationMetricsV3_unattended:
description: API call counts for the unattended tier
example:
previousDays:
- 9
- 9
currentDay: 7
properties:
currentDay:
description: API call counts for current day
type: integer
x-cds-type: NaturalNumber
previousDays:
description: API call counts for previous days. The first element indicates
yesterday and so on. A maximum of seven entries is required if available
items:
type: integer
x-cds-type: NaturalNumber
type: array
type: object
x-conditional:
- currentDay
- previousDays
InvocationMetricsV3_largePayload:
description: API call counts for the large payload tier
example:
previousDays:
- 2
- 2
currentDay: 3
properties:
currentDay:
description: API call counts for current day
type: integer
x-cds-type: NaturalNumber
previousDays:
description: API call counts for previous days. The first element indicates
yesterday and so on. A maximum of seven entries is required if available
items:
type: integer
x-cds-type: NaturalNumber
type: array
type: object
x-conditional:
- currentDay
- previousDays
InvocationMetricsV3_secondary:
description: API call counts for the Shared Responsibility Data Requests tier. Mandatory
for data holders designated for a Shared Responsibility Data Request data
cluster
example:
previousDays:
- 7
- 7
currentDay: 4
properties:
currentDay:
description: API call counts for current day
type: integer
x-cds-type: NaturalNumber
previousDays:
description: API call counts for previous days. The first element indicates
yesterday and so on. A maximum of seven entries is required if available
items:
type: integer
x-cds-type: NaturalNumber
type: array
type: object
x-conditional:
- currentDay
- previousDays
InvocationMetricsV3_largeSecondary:
description: API call counts for the large Shared Responsibility Data Requests
tier. Mandatory for data holders designated for a Shared Responsibility Data
Request data cluster
example:
previousDays:
- 1
- 1
currentDay: 1
properties:
currentDay:
description: API call counts for current day
type: integer
x-cds-type: NaturalNumber
previousDays:
description: API call counts for previous days. The first element indicates
yesterday and so on. A maximum of seven entries is required if available
items:
type: integer
x-cds-type: NaturalNumber
type: array
type: object
x-conditional:
- currentDay
- previousDays
AverageResponseMetricsV2_unauthenticated:
description: Average response time for the unauthenticated tier
example:
previousDays:
- 6.84685269835264
- 6.84685269835264
currentDay: 1.4894159098541704
properties:
currentDay:
description: Average response time for current day
type: number
previousDays:
description: Average response time for previous days. The first element
indicates yesterday and so on. A maximum of seven entries is required
if available.
items:
type: number
type: array
type: object
x-conditional:
- currentDay
- previousDays
AverageResponseMetricsV2_highPriority:
description: Average response time for the high priority tier
example:
previousDays:
- 1.1730742509559433
- 1.1730742509559433
currentDay: 7.457744773683766
properties:
currentDay:
description: Average response time for current day
type: number
previousDays:
description: Average response time for previous days. The first element
indicates yesterday and so on. A maximum of seven entries is required
if available.
items:
type: number
type: array
type: object
x-conditional:
- currentDay
- previousDays
AverageResponseMetricsV2_lowPriority:
description: Average response time for the low priority tier
example:
previousDays:
- 5.025004791520295
- 5.025004791520295
currentDay: 4.965218492984954
properties:
currentDay:
description: Average response time for current day
type: number
previousDays:
description: Average response time for previous days. The first element
indicates yesterday and so on. A maximum of seven entries is required
if available.
items:
type: number
type: array
type: object
x-conditional:
- currentDay
- previousDays
AverageResponseMetricsV2_unattended:
description: Average response time for the unattended tier
example:
previousDays:
- 9.369310271410669
- 9.369310271410669
currentDay: 9.965781217890562
properties:
currentDay:
description: Average response time for current day
type: number
previousDays:
description: Average response time for previous days. The first element
indicates yesterday and so on. A maximum of seven entries is required
if available.
items:
type: number
type: array
type: object
x-conditional:
- currentDay
- previousDays
AverageResponseMetricsV2_largePayload:
description: Average response time for the large payload tier
example:
previousDays:
- 8.762042012749001
- 8.762042012749001
currentDay: 6.683562403749608
properties:
currentDay:
description: Average response time for current day
type: number
previousDays:
description: Average response time for previous days. The first element
indicates yesterday and so on. A maximum of seven entries is required
if available.
items:
type: number
type: array
type: object
x-conditional:
- currentDay
- previousDays
AverageResponseMetricsV2_secondary_primary:
description: Average response time as measured for the primary data holder
example:
previousDays:
- 6.438423552598547
- 6.438423552598547
currentDay: 9.018348186070783
properties:
currentDay:
description: Average response time for current day
type: number
previousDays:
description: Average response time for previous days. The first element
indicates yesterday and so on. A maximum of seven entries is required
if available.
items:
type: number
type: array
type: object
x-conditional:
- currentDay
- previousDays
AverageResponseMetricsV2_secondary_secondary:
description: Average response time as measured for the secondary data holder
example:
previousDays:
- 6.965117697638846
- 6.965117697638846
currentDay: 3.5571952270680973
properties:
currentDay:
description: Average response time for current day
type: number
previousDays:
description: Average response time for previous days. The first element
indicates yesterday and so on. A maximum of seven entries is required
if available.
items:
type: number
type: array
type: object
x-conditional:
- currentDay
- previousDays
AverageResponseMetricsV2_secondary:
description: Average response time for the secondary tier. Mandatory for data
holders designated for a Shared Responsibility Data Request data cluster
example:
secondary:
previousDays:
- 6.965117697638846
- 6.965117697638846
currentDay: 3.5571952270680973
primary:
previousDays:
- 6.438423552598547
- 6.438423552598547
currentDay: 9.018348186070783
properties:
primary:
$ref: '#/components/schemas/AverageResponseMetricsV2_secondary_primary'
secondary:
$ref: '#/components/schemas/AverageResponseMetricsV2_secondary_secondary'
required:
- primary
- secondary
type: object
AverageResponseMetricsV2_largeSecondary:
description: Average response time for the large payload tier. Mandatory for
data holders designated for a Shared Responsibility Data Request data cluster
example:
secondary:
previousDays:
- 6.965117697638846
- 6.965117697638846
currentDay: 3.5571952270680973
primary:
previousDays:
- 6.438423552598547
- 6.438423552598547
currentDay: 9.018348186070783
properties:
primary:
$ref: '#/components/schemas/AverageResponseMetricsV2_secondary_primary'
secondary:
$ref: '#/components/schemas/AverageResponseMetricsV2_secondary_secondary'
required:
- primary
- secondary
type: object
AverageTPSMetricsV2_aggregate:
description: Aggregate average transactions per second over time for all endpoints
example:
previousDays:
- 6.878052220127876
- 6.878052220127876
currentDay: 6.778324963048013
properties:
currentDay:
description: Average TPS for current day. Must be a positive value or zero
type: number
previousDays:
description: Average TPS for previous days. The first element indicates
yesterday and so on. A maximum of seven entries is required if available.
Values must be a positive or zero
items:
type: number
type: array
type: object
x-conditional:
- currentDay
- previousDays
AverageTPSMetricsV2_unauthenticated:
description: Average transactions per second over time for unauthenticated endpoints
example:
previousDays:
- 6.704019297950036
- 6.704019297950036
currentDay: 5.944895607614016
properties:
currentDay:
description: Average TPS for current day. Must be a positive value or zero
type: number
previousDays:
description: Average TPS for previous days. The first element indicates
yesterday and so on. A maximum of seven entries is required if available.
Values must be a positive or zero
items:
type: number
type: array
type: object
x-conditional:
- currentDay
- previousDays
AverageTPSMetricsV2_authenticated:
description: Average transactions per second over time for authenticated endpoints
example:
previousDays:
- 3.0937452626664474
- 3.0937452626664474
currentDay: 3.353193347011243
properties:
currentDay:
description: Average TPS for current day. Must be a positive value or zero
type: number
previousDays:
description: Average TPS for previous days. The first element indicates
yesterday and so on. A maximum of seven entries is required if available.
Values must be a positive or zero
items:
type: number
type: array
type: object
x-conditional:
- currentDay
- previousDays
PeakTPSMetricsV2_aggregate:
description: Aggregate peak transactions per second over time for all endpoints
example:
previousDays:
- 0.8851374739011653
- 0.8851374739011653
currentDay: 7.143538047012306
properties:
currentDay:
description: Peak TPS for current day. Must be a positive value or zero
type: number
previousDays:
description: Peak TPS for previous days. The first element indicates yesterday
and so on. A maximum of seven entries is required if available. Values
must be a positive or zero
items:
type: number
type: array
type: object
x-conditional:
- currentDay
- previousDays
PeakTPSMetricsV2_unauthenticated:
description: Peak transactions per second over time for unauthenticated endpoints
example:
previousDays:
- 6.519180951018382
- 6.519180951018382
currentDay: 7.058770351582356
properties:
currentDay:
description: Peak TPS for current day. Must be a positive value or zero
type: number
previousDays:
description: Peak TPS for previous days. The first element indicates yesterday
and so on. A maximum of seven entries is required if available. Values
must be a positive or zero
items:
type: number
type: array
type: object
x-conditional:
- currentDay
- previousDays
PeakTPSMetricsV2_authenticated:
description: Peak transactions per second over time for authenticated endpoints
example:
previousDays:
- 4.652396432933246
- 4.652396432933246
currentDay: 0.10263654006109402
properties:
currentDay:
description: Peak TPS for current day. Must be a positive value or zero
type: number
previousDays:
description: Peak TPS for previous days. The first element indicates yesterday
and so on. A maximum of seven entries is required if available. Values
must be a positive or zero
items:
type: number
type: array
type: object
x-conditional:
- currentDay
- previousDays
ErrorMetricsV2_aggregate:
description: Aggregate number of calls resulting in error due to server execution
over time for all endpoints
example:
previousDays:
- 7
- 7
currentDay: 8
properties:
currentDay:
description: Error counts for current day
type: integer
x-cds-type: NaturalNumber
previousDays:
description: Error counts for previous days. The first element indicates
yesterday and so on. A maximum of seven entries is required if available
items:
type: integer
x-cds-type: NaturalNumber
type: array
type: object
x-conditional:
- currentDay
- previousDays
ErrorMetricsV2_unauthenticated:
description: Number of calls resulting in error for unauthenticated endpoints
example:
previousDays:
- key: 3
- key: 3
currentDay:
key: 3
properties:
currentDay:
additionalProperties:
description: Number of errors for a specific HTTP error code. Note that
the property name must be 3 digits represent the HTTP error code the
error is for
type: integer
x-cds-type: NaturalNumber
description: Error counts, by HTTP error code, for current day
properties:
"500":
description: Number of errors for HTTP error code 500. Note that this
field is an example of a single entry due to the lack of OAS support
for the JSON Schema `patternProperties` syntax. See the `additionalProperties`
field in this schema for the generic property structure for error
code counts
type: integer
x-cds-type: NaturalNumber
type: object
previousDays:
description: Error counts, by HTTP error code, for previous days. The first
element indicates yesterday and so on. A maximum of seven entries is required
if available
items:
additionalProperties:
description: Number of errors for a specific HTTP error code. Note
that the property name must be 3 digits represent the HTTP error code
the error is for
type: integer
x-cds-type: NaturalNumber
properties:
"500":
description: Number of errors for HTTP error code 500. Note that
this field is an example of a single entry due to the lack of OAS
support JSON Schema `patternProperties` syntax. See the `additionalProperties`
field in this schema for the generic property structure for error
code counts
type: integer
x-cds-type: NaturalNumber
type: object
type: array
type: object
x-conditional:
- currentDay
- previousDays
ErrorMetricsV2_authenticated:
description: Number of calls resulting in error for authenticated endpoints
example:
previousDays:
- key: 5
- key: 5
currentDay:
key: 7
properties:
currentDay:
additionalProperties:
description: Number of errors for a specific HTTP error code. Note that
the property name must be 3 digits represent the HTTP error code the
error is for
type: integer
x-cds-type: NaturalNumber
description: Error counts, by HTTP error code, for current day
properties:
"500":
description: Number of errors for HTTP error code 500. Note that this
field is an example of a single entry due to the lack of OAS support
for the JSON Schema `patternProperties` syntax. See the `additionalProperties`
field in this schema for the generic property structure for error
code counts
type: integer
x-cds-type: NaturalNumber
type: object
previousDays:
description: Error counts, by HTTP error code, for previous days. The first
element indicates yesterday and so on. A maximum of seven entries is required
if available
items:
additionalProperties:
description: Number of errors for a specific HTTP error code. Note
that the property name must be 3 digits represent the HTTP error code
the error is for
type: integer
x-cds-type: NaturalNumber
properties:
"500":
description: Number of errors for HTTP error code 500. Note that
this field is an example of a single entry due to the lack of OAS
support JSON Schema `patternProperties` syntax. See the `additionalProperties`
field in this schema for the generic property structure for error
code counts
type: integer
x-cds-type: NaturalNumber
type: object
type: array
type: object
x-conditional:
- currentDay
- previousDays
RejectionMetricsV3_authenticated:
description: Rejection counts for all authenticated end points
example:
previousDays:
- 4
- 4
currentDay: 3
properties:
currentDay:
description: Number of calls rejected for current day
type: integer
x-cds-type: NaturalNumber
previousDays:
description: Number of calls rejected for previous days. The first element
indicates yesterday and so on. A maximum of seven entries is required
if available.
items:
type: integer
x-cds-type: NaturalNumber
type: array
type: object
x-conditional:
- currentDay
- previousDays
RejectionMetricsV3_unauthenticated:
description: Rejection counts for all unauthenticated end points
example:
previousDays:
- 6
- 6
currentDay: 0
properties:
currentDay:
description: Number of calls rejected for current day
type: integer
x-cds-type: NaturalNumber
previousDays:
description: Number of calls rejected for previous days. The first element
indicates yesterday and so on. A maximum of seven entries is required
if available.
items:
type: integer
x-cds-type: NaturalNumber
type: array
type: object
x-conditional:
- currentDay
- previousDays
SecondaryHolderMetricsV2_errors:
description: Number of calls resulting in error due to server execution over
time
example:
previousDays:
- 7
- 7
currentDay: 4
properties:
currentDay:
description: Number of errors for current day
type: integer
x-cds-type: NaturalNumber
previousDays:
description: Number of errors for previous days. The first element indicates
yesterday and so on. A maximum of seven entries is required if available
items:
type: integer
x-cds-type: NaturalNumber
type: array
type: object
x-conditional:
- currentDay
- previousDays
SecondaryHolderMetricsV2_rejections:
description: Number of calls rejected due to traffic thresholds over time
example:
previousDays:
- 0
- 0
currentDay: 9
properties:
currentDay:
description: Number of rejections for current day
type: integer
x-cds-type: NaturalNumber
previousDays:
description: Number of rejections for previous days. The first element indicates
yesterday and so on. A maximum of seven entries is required if available
items:
type: integer
x-cds-type: NaturalNumber
type: array
type: object
x-conditional:
- currentDay
- previousDays
AuthorisationMetricsV2_activeAuthorisationCount:
description: The number of active ongoing authorisations
example:
nonIndividual: 0
individual: 9
properties:
individual:
description: Active ongoing authorisation count for individual customers
type: integer
x-cds-type: NaturalNumber
nonIndividual:
description: Active ongoing authorisation count for non-individual customers
type: integer
x-cds-type: NaturalNumber
required:
- individual
- nonIndividual
type: object
AuthorisationMetricsV2_newAuthorisationCount_currentDay_onceOff:
description: New authorisation count for once-off authorisations
example:
nonIndividual: 5
individual: 7
properties:
individual:
description: New authorisation count for individual customers
type: integer
x-cds-type: NaturalNumber
nonIndividual:
description: New authorisation count for non-individual customers
type: integer
x-cds-type: NaturalNumber
required:
- individual
- nonIndividual
type: object
AuthorisationMetricsV2_newAuthorisationCount_currentDay_ongoing:
description: New authorisation count for ongoing authorisations
example:
nonIndividual: 6
individual: 4
properties:
individual:
description: New authorisation count for individual customers
type: integer
x-cds-type: NaturalNumber
nonIndividual:
description: New authorisation count for non-individual customers
type: integer
x-cds-type: NaturalNumber
required:
- individual
- nonIndividual
type: object
AuthorisationMetricsV2_newAuthorisationCount_currentDay:
description: Number of new authorisations for the current day
example:
ongoing:
nonIndividual: 6
individual: 4
onceOff:
nonIndividual: 5
individual: 7
properties:
onceOff:
$ref: '#/components/schemas/AuthorisationMetricsV2_newAuthorisationCount_currentDay_onceOff'
ongoing:
$ref: '#/components/schemas/AuthorisationMetricsV2_newAuthorisationCount_currentDay_ongoing'
required:
- onceOff
- ongoing
type: object
AuthorisationMetricsV2_newAuthorisationCount_previousDays:
example:
ongoing:
nonIndividual: 6
individual: 4
onceOff:
nonIndividual: 5
individual: 7
properties:
onceOff:
$ref: '#/components/schemas/AuthorisationMetricsV2_newAuthorisationCount_currentDay_onceOff'
ongoing:
$ref: '#/components/schemas/AuthorisationMetricsV2_newAuthorisationCount_currentDay_ongoing'
required:
- onceOff
- ongoing
type: object
AuthorisationMetricsV2_newAuthorisationCount:
description: The number of new authorisations
example:
previousDays:
- ongoing:
nonIndividual: 6
individual: 4
onceOff:
nonIndividual: 5
individual: 7
- ongoing:
nonIndividual: 6
individual: 4
onceOff:
nonIndividual: 5
individual: 7
currentDay:
ongoing:
nonIndividual: 6
individual: 4
onceOff:
nonIndividual: 5
individual: 7
properties:
currentDay:
$ref: '#/components/schemas/AuthorisationMetricsV2_newAuthorisationCount_currentDay'
previousDays:
description: Number of new authorisations for previous days. The first element
indicates yesterday and so on. A maximum of seven entries is required
if available
items:
$ref: '#/components/schemas/AuthorisationMetricsV2_newAuthorisationCount_previousDays'
type: array
type: object
x-conditional:
- currentDay
- previousDays
AuthorisationMetricsV2_revokedAuthorisationCount_currentDay:
description: Number of revoked authorisations for the current day
example:
nonIndividual: 4
individual: 8
properties:
individual:
description: Revoked authorisation count for individual customers
type: integer
x-cds-type: NaturalNumber
nonIndividual:
description: Revoked authorisation count for non-individual customers
type: integer
x-cds-type: NaturalNumber
required:
- individual
- nonIndividual
type: object
AuthorisationMetricsV2_revokedAuthorisationCount_previousDays:
example:
nonIndividual: 0
individual: 3
properties:
individual:
description: Revoked authorisation count for individual customers
type: integer
x-cds-type: NaturalNumber
nonIndividual:
description: Revoked authorisation count for non-individual customers
type: integer
x-cds-type: NaturalNumber
required:
- individual
- nonIndividual
type: object
AuthorisationMetricsV2_revokedAuthorisationCount:
description: The number of revoked authorisations
example:
previousDays:
- nonIndividual: 0
individual: 3
- nonIndividual: 0
individual: 3
currentDay:
nonIndividual: 4
individual: 8
properties:
currentDay:
$ref: '#/components/schemas/AuthorisationMetricsV2_revokedAuthorisationCount_currentDay'
previousDays:
description: Number of revoked authorisations for previous days. The first
element indicates yesterday and so on. A maximum of seven entries is required
if available
items:
$ref: '#/components/schemas/AuthorisationMetricsV2_revokedAuthorisationCount_previousDays'
type: array
type: object
x-conditional:
- currentDay
- previousDays
AuthorisationMetricsV2_amendedAuthorisationCount_currentDay:
description: Number of amended authorisations for the current day
example:
nonIndividual: 1
individual: 2
properties:
individual:
description: Amended authorisation count for individual customers
type: integer
x-cds-type: NaturalNumber
nonIndividual:
description: Amended authorisation count for non-individual customers
type: integer
x-cds-type: NaturalNumber
required:
- individual
- nonIndividual
type: object
AuthorisationMetricsV2_amendedAuthorisationCount_previousDays:
example:
nonIndividual: 6
individual: 8
properties:
individual:
description: Amended authorisation count for individual customers
type: integer
x-cds-type: NaturalNumber
nonIndividual:
description: Amended authorisation count for non-individual customers
type: integer
x-cds-type: NaturalNumber
required:
- individual
- nonIndividual
type: object
AuthorisationMetricsV2_amendedAuthorisationCount:
description: The number of amended ongoing authorisations
example:
previousDays:
- nonIndividual: 6
individual: 8
- nonIndividual: 6
individual: 8
currentDay:
nonIndividual: 1
individual: 2
properties:
currentDay:
$ref: '#/components/schemas/AuthorisationMetricsV2_amendedAuthorisationCount_currentDay'
previousDays:
description: Number of amended authorisations for previous days. The first
element indicates yesterday and so on. A maximum of seven entries is required
if available
items:
$ref: '#/components/schemas/AuthorisationMetricsV2_amendedAuthorisationCount_previousDays'
type: array
type: object
x-conditional:
- currentDay
- previousDays
AuthorisationMetricsV2_expiredAuthorisationCount_currentDay:
description: Number of expired authorisations for the current day
example:
nonIndividual: 8
individual: 4
properties:
individual:
description: Expired authorisation count for individual customers
type: integer
x-cds-type: NaturalNumber
nonIndividual:
description: Expired authorisation count for non-individual customers
type: integer
x-cds-type: NaturalNumber
required:
- individual
- nonIndividual
type: object
AuthorisationMetricsV2_expiredAuthorisationCount_previousDays:
example:
nonIndividual: 1
individual: 9
properties:
individual:
description: Expired authorisation count for individual customers
type: integer
x-cds-type: NaturalNumber
nonIndividual:
description: Expired authorisation count for non-individual customers
type: integer
x-cds-type: NaturalNumber
required:
- individual
- nonIndividual
type: object
AuthorisationMetricsV2_expiredAuthorisationCount:
description: The number of expired ongoing authorisations
example:
previousDays:
- nonIndividual: 1
individual: 9
- nonIndividual: 1
individual: 9
currentDay:
nonIndividual: 8
individual: 4
properties:
currentDay:
$ref: '#/components/schemas/AuthorisationMetricsV2_expiredAuthorisationCount_currentDay'
previousDays:
description: Number of expired authorisations for previous days. The first
element indicates yesterday and so on. A maximum of seven entries is required
if available
items:
$ref: '#/components/schemas/AuthorisationMetricsV2_expiredAuthorisationCount_previousDays'
type: array
type: object
x-conditional:
- currentDay
- previousDays
AuthorisationMetricsV2_abandonedConsentFlowCount:
description: The number of consents flows that were not successfully authorised
example:
previousDays:
- 9
- 9
currentDay: 3
properties:
currentDay:
description: Number of consents flows that were not successfully authorised
for the current day
type: integer
x-cds-type: NaturalNumber
previousDays:
description: Number of consents flows that were not successfully authorised
for previous days. The first element indicates yesterday and so on. A
maximum of seven entries is required if available
items:
type: integer
x-cds-type: NaturalNumber
type: array
type: object
x-conditional:
- currentDay
- previousDays
AuthorisationMetricsV2_abandonmentsByStage_preIdentification:
description: The number of authorisations that commenced with the data holder
but the customer did not successfully identify their profile or user ID
example:
previousDays:
- 0
- 0
currentDay: 8
properties:
currentDay:
description: Number of abandoned consent flows for this stage for the current
day
type: integer
x-cds-type: NaturalNumber
previousDays:
description: Number of abandoned consent flows for this stage for previous
days. The first element indicates yesterday and so on. A maximum of seven
entries is required if available
items:
type: integer
x-cds-type: NaturalNumber
type: array
type: object
x-conditional:
- currentDay
- previousDays
AuthorisationMetricsV2_abandonmentsByStage_preAuthentication:
description: The number of authorisations where the customer identified themselves
(ie. they successfully identify the customer profile to use for the authorisation)
but failed to provide a valid OTP or equivalent
example:
previousDays:
- 5
- 5
currentDay: 5
properties:
currentDay:
description: Number of abandoned consent flows for this stage for the current
day
type: integer
x-cds-type: NaturalNumber
previousDays:
description: Number of abandoned consent flows for this stage for previous
days. The first element indicates yesterday and so on. A maximum of seven
entries is required if available
items:
type: integer
x-cds-type: NaturalNumber
type: array
type: object
x-conditional:
- currentDay
- previousDays
AuthorisationMetricsV2_abandonmentsByStage_preAccountSelection:
description: The number of authorisations where the customer successfully authenticated
with a valid OTP or equivalent but abandoned the process before selecting
accounts
example:
previousDays:
- 7
- 7
currentDay: 8
properties:
currentDay:
description: Number of abandoned consent flows for this stage for the current
day
type: integer
x-cds-type: NaturalNumber
previousDays:
description: Number of abandoned consent flows for this stage for previous
days. The first element indicates yesterday and so on. A maximum of seven
entries is required if available
items:
type: integer
x-cds-type: NaturalNumber
type: array
type: object
x-conditional:
- currentDay
- previousDays
AuthorisationMetricsV2_abandonmentsByStage_preAuthorisation:
description: The number of authorisations where the customer has passed the
account selection step but abandoned the process before approving or rejecting
the consent being requested
example:
previousDays:
- 3
- 3
currentDay: 3
properties:
currentDay:
description: Number of abandoned consent flows for this stage for the current
day
type: integer
x-cds-type: NaturalNumber
previousDays:
description: Number of abandoned consent flows for this stage for previous
days. The first element indicates yesterday and so on. A maximum of seven
entries is required if available
items:
type: integer
x-cds-type: NaturalNumber
type: array
type: object
x-conditional:
- currentDay
- previousDays
AuthorisationMetricsV2_abandonmentsByStage_rejected:
description: The number of authorisations where the customer actively rejected
the authorisation rather than abandoning the process
example:
previousDays:
- 5
- 5
currentDay: 9
properties:
currentDay:
description: Number of abandoned consent flows for this stage for the current
day
type: integer
x-cds-type: NaturalNumber
previousDays:
description: Number of abandoned consent flows for this stage for previous
days. The first element indicates yesterday and so on. A maximum of seven
entries is required if available
items:
type: integer
x-cds-type: NaturalNumber
type: array
type: object
x-conditional:
- currentDay
- previousDays
AuthorisationMetricsV2_abandonmentsByStage_failedTokenExchange:
description: 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 refresh or access token using the authorisation code
example:
previousDays:
- 0
- 0
currentDay: 7
properties:
currentDay:
description: Number of abandoned consent flows for this stage for the current
day
type: integer
x-cds-type: NaturalNumber
previousDays:
description: Number of abandoned consent flows for this stage for previous
days. The first element indicates yesterday and so on. A maximum of seven
entries is required if available
items:
type: integer
x-cds-type: NaturalNumber
type: array
type: object
x-conditional:
- currentDay
- previousDays
AuthorisationMetricsV2_abandonmentsByStage:
description: 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 `abandonedConsentFlowCount` for the same period (ie. each abandoned
consent should assigned to one, and only one, stage)
example:
preAuthorisation:
previousDays:
- 3
- 3
currentDay: 3
rejected:
previousDays:
- 5
- 5
currentDay: 9
preAccountSelection:
previousDays:
- 7
- 7
currentDay: 8
preIdentification:
previousDays:
- 0
- 0
currentDay: 8
failedTokenExchange:
previousDays:
- 0
- 0
currentDay: 7
preAuthentication:
previousDays:
- 5
- 5
currentDay: 5
properties:
preIdentification:
$ref: '#/components/schemas/AuthorisationMetricsV2_abandonmentsByStage_preIdentification'
preAuthentication:
$ref: '#/components/schemas/AuthorisationMetricsV2_abandonmentsByStage_preAuthentication'
preAccountSelection:
$ref: '#/components/schemas/AuthorisationMetricsV2_abandonmentsByStage_preAccountSelection'
preAuthorisation:
$ref: '#/components/schemas/AuthorisationMetricsV2_abandonmentsByStage_preAuthorisation'
rejected:
$ref: '#/components/schemas/AuthorisationMetricsV2_abandonmentsByStage_rejected'
failedTokenExchange:
$ref: '#/components/schemas/AuthorisationMetricsV2_abandonmentsByStage_failedTokenExchange'
required:
- failedTokenExchange
- preAccountSelection
- preAuthentication
- preAuthorisation
- preIdentification
- rejected
type: object
ResponseErrorListV2_errors:
properties:
code:
description: The code of the error encountered. Where the error is specific
to the respondent, an application-specific error code, expressed as a
string value. If the error is application-specific, the URN code that
the specific error extends must be provided in the meta object. Otherwise,
the value is the error code URN.
type: string
title:
description: A short, human-readable summary of the problem that MUST NOT
change from occurrence to occurrence of the problem represented by the
error code.
type: string
detail:
description: A human-readable explanation specific to this occurrence of
the problem.
type: string
meta:
$ref: '#/components/schemas/MetaError'
required:
- code
- detail
- title
type: object