Get Metrics V5

This page documents the deprecated version 5 of the Get Metrics endpoint.

This version SHALL NOT be called by the CDR Register from December 10th 2027 and can be decommissioned by affected data holders as of that date.

Get Metrics

Code samples

GET https://mtls.dh.example.com/cds-au/v1/admin/metrics HTTP/1.1
Host: mtls.dh.example.com
Accept: application/json
x-v: string
x-min-v: string

const fetch = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'x-v':'string',
  'x-min-v':'string'
};

fetch('https://mtls.dh.example.com/cds-au/v1/admin/metrics', {
  method: 'GET',
  headers: headers
}).then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /admin/metrics

This endpoint 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 endpoint are determined by the non-functional requirements for the CDR regime.

This endpoint 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 v2.

Deprecated versions:

• v3 - 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 - 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.

Endpoint Version

Version	5

Parameters

Name	In	Type	Required	Default	Description
period	query	Enum	optional	ALL	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.
x-v	header	string	mandatory		Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the endpoint should respond with a 406 Not Acceptable. See HTTP Headers.
x-min-v	header	string	optional		Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The endpoint should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the endpoint should respond with a 406 Not Acceptable.

Enumerated Values

Parameter	Value
period	CURRENT
period	HISTORIC
period	ALL

Example responses

200 Response

{
  "data": {
    "requestTime": "string",
    "availability": {
      "aggregate": {
        "currentMonth": "string",
        "previousMonths": [
          "string"
        ]
      },
      "unauthenticated": {
        "currentMonth": "string",
        "previousMonths": [
          "string"
        ]
      },
      "authenticated": {
        "currentMonth": "string",
        "previousMonths": [
          "string"
        ]
      }
    },
    "performance": {
      "aggregate": {
        "currentDay": "string",
        "previousDays": [
          "string"
        ]
      },
      "highPriority": {
        "currentDay": [
          "string"
        ],
        "previousDays": [
          [
            "string"
          ]
        ]
      },
      "largePayload": {
        "currentDay": [
          "string"
        ],
        "previousDays": [
          [
            "string"
          ]
        ]
      },
      "lowPriority": {
        "currentDay": [
          "string"
        ],
        "previousDays": [
          [
            "string"
          ]
        ]
      },
      "unattended": {
        "currentDay": [
          "string"
        ],
        "previousDays": [
          [
            "string"
          ]
        ]
      },
      "unauthenticated": {
        "currentDay": [
          "string"
        ],
        "previousDays": [
          [
            "string"
          ]
        ]
      },
      "secondary": {
        "primary": {
          "currentDay": [
            "string"
          ],
          "previousDays": [
            [
              "string"
            ]
          ]
        },
        "secondary": {
          "currentDay": [
            "string"
          ],
          "previousDays": [
            [
              "string"
            ]
          ]
        }
      },
      "largeSecondary": {
        "primary": {
          "currentDay": [
            "string"
          ],
          "previousDays": [
            [
              "string"
            ]
          ]
        },
        "secondary": {
          "currentDay": [
            "string"
          ],
          "previousDays": [
            [
              "string"
            ]
          ]
        }
      }
    },
    "invocations": {
      "unauthenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "highPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "lowPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unattended": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "largePayload": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "secondary": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "largeSecondary": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      }
    },
    "averageResponse": {
      "unauthenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "highPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "lowPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unattended": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "largePayload": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "secondary": {
        "primary": {
          "currentDay": 0,
          "previousDays": [
            0
          ]
        },
        "secondary": {
          "currentDay": 0,
          "previousDays": [
            0
          ]
        }
      },
      "largeSecondary": {
        "primary": {
          "currentDay": 0,
          "previousDays": [
            0
          ]
        },
        "secondary": {
          "currentDay": 0,
          "previousDays": [
            0
          ]
        }
      }
    },
    "sessionCount": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "averageTps": {
      "aggregate": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unauthenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "authenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      }
    },
    "peakTps": {
      "aggregate": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unauthenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "authenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      }
    },
    "errors": {
      "aggregate": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unauthenticated": {
        "currentDay": {
          "500": 0,
          "property1": 0,
          "property2": 0
        },
        "previousDays": [
          {
            "500": 0,
            "property1": 0,
            "property2": 0
          }
        ]
      },
      "authenticated": {
        "currentDay": {
          "500": 0,
          "property1": 0,
          "property2": 0
        },
        "previousDays": [
          {
            "500": 0,
            "property1": 0,
            "property2": 0
          }
        ]
      }
    },
    "rejections": {
      "authenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unauthenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      }
    },
    "customerCount": 0,
    "recipientCount": 0,
    "secondaryHolder": {
      "errors": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "rejections": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      }
    },
    "authorisations": {
      "activeAuthorisationCount": {
        "individual": 0,
        "nonIndividual": 0
      },
      "newAuthorisationCount": {
        "currentDay": {
          "onceOff": {
            "individual": 0,
            "nonIndividual": 0
          },
          "ongoing": {
            "individual": 0,
            "nonIndividual": 0
          }
        },
        "previousDays": [
          {
            "onceOff": {
              "individual": 0,
              "nonIndividual": 0
            },
            "ongoing": {
              "individual": 0,
              "nonIndividual": 0
            }
          }
        ]
      },
      "revokedAuthorisationCount": {
        "currentDay": {
          "individual": 0,
          "nonIndividual": 0
        },
        "previousDays": [
          {
            "individual": 0,
            "nonIndividual": 0
          }
        ]
      },
      "amendedAuthorisationCount": {
        "currentDay": {
          "individual": 0,
          "nonIndividual": 0
        },
        "previousDays": [
          {
            "individual": 0,
            "nonIndividual": 0
          }
        ]
      },
      "expiredAuthorisationCount": {
        "currentDay": {
          "individual": 0,
          "nonIndividual": 0
        },
        "previousDays": [
          {
            "individual": 0,
            "nonIndividual": 0
          }
        ]
      },
      "abandonedConsentFlowCount": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "abandonmentsByStage": {
        "preIdentification": {
          "currentDay": 0,
          "previousDays": [
            0
          ]
        },
        "preAuthentication": {
          "currentDay": 0,
          "previousDays": [
            0
          ]
        },
        "preAccountSelection": {
          "currentDay": 0,
          "previousDays": [
            0
          ]
        },
        "preAuthorisation": {
          "currentDay": 0,
          "previousDays": [
            0
          ]
        },
        "rejected": {
          "currentDay": 0,
          "previousDays": [
            0
          ]
        },
        "failedTokenExchange": {
          "currentDay": 0,
          "previousDays": [
            0
          ]
        }
      }
    }
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	ResponseMetricsListV5
400	Bad Request	The following error codes MUST be supported: 400 - Invalid Field 400 - Missing Required Field 400 - Invalid Version	ResponseErrorListV2
406	Not Acceptable	The following error codes MUST be supported: 406 - Unsupported Version	ResponseErrorListV2

Response Headers

Status	Header	Type	Required	Description
200	x-v	string	mandatory	The payload version that the endpoint has responded with.

Schemas

RequestMetaDataUpdateV1

{
  "data": {
    "action": "REFRESH"
  },
  "meta": {}
}

Properties

Name	Type	Required	Default	Description
data	object	mandatory		none
» action	Enum	mandatory	REFRESH	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.
meta	Meta	optional		none

Enumerated Values

Property	Value
action	REFRESH

ResponseMetricsListV5

{
  "data": {
    "requestTime": "string",
    "availability": {
      "aggregate": {
        "currentMonth": "string",
        "previousMonths": [
          "string"
        ]
      },
      "unauthenticated": {
        "currentMonth": "string",
        "previousMonths": [
          "string"
        ]
      },
      "authenticated": {
        "currentMonth": "string",
        "previousMonths": [
          "string"
        ]
      }
    },
    "performance": {
      "aggregate": {
        "currentDay": "string",
        "previousDays": [
          "string"
        ]
      },
      "highPriority": {
        "currentDay": [
          "string"
        ],
        "previousDays": [
          [
            "string"
          ]
        ]
      },
      "largePayload": {
        "currentDay": [
          "string"
        ],
        "previousDays": [
          [
            "string"
          ]
        ]
      },
      "lowPriority": {
        "currentDay": [
          "string"
        ],
        "previousDays": [
          [
            "string"
          ]
        ]
      },
      "unattended": {
        "currentDay": [
          "string"
        ],
        "previousDays": [
          [
            "string"
          ]
        ]
      },
      "unauthenticated": {
        "currentDay": [
          "string"
        ],
        "previousDays": [
          [
            "string"
          ]
        ]
      },
      "secondary": {
        "primary": {
          "currentDay": [
            "string"
          ],
          "previousDays": [
            [
              "string"
            ]
          ]
        },
        "secondary": {
          "currentDay": [
            "string"
          ],
          "previousDays": [
            [
              "string"
            ]
          ]
        }
      },
      "largeSecondary": {
        "primary": {
          "currentDay": [
            "string"
          ],
          "previousDays": [
            [
              "string"
            ]
          ]
        },
        "secondary": {
          "currentDay": [
            "string"
          ],
          "previousDays": [
            [
              "string"
            ]
          ]
        }
      }
    },
    "invocations": {
      "unauthenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "highPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "lowPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unattended": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "largePayload": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "secondary": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "largeSecondary": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      }
    },
    "averageResponse": {
      "unauthenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "highPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "lowPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unattended": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "largePayload": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "secondary": {
        "primary": {
          "currentDay": 0,
          "previousDays": [
            0
          ]
        },
        "secondary": {
          "currentDay": 0,
          "previousDays": [
            0
          ]
        }
      },
      "largeSecondary": {
        "primary": {
          "currentDay": 0,
          "previousDays": [
            0
          ]
        },
        "secondary": {
          "currentDay": 0,
          "previousDays": [
            0
          ]
        }
      }
    },
    "sessionCount": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "averageTps": {
      "aggregate": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unauthenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "authenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      }
    },
    "peakTps": {
      "aggregate": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unauthenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "authenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      }
    },
    "errors": {
      "aggregate": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unauthenticated": {
        "currentDay": {
          "500": 0,
          "property1": 0,
          "property2": 0
        },
        "previousDays": [
          {
            "500": 0,
            "property1": 0,
            "property2": 0
          }
        ]
      },
      "authenticated": {
        "currentDay": {
          "500": 0,
          "property1": 0,
          "property2": 0
        },
        "previousDays": [
          {
            "500": 0,
            "property1": 0,
            "property2": 0
          }
        ]
      }
    },
    "rejections": {
      "authenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unauthenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      }
    },
    "customerCount": 0,
    "recipientCount": 0,
    "secondaryHolder": {
      "errors": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "rejections": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      }
    },
    "authorisations": {
      "activeAuthorisationCount": {
        "individual": 0,
        "nonIndividual": 0
      },
      "newAuthorisationCount": {
        "currentDay": {
          "onceOff": {
            "individual": 0,
            "nonIndividual": 0
          },
          "ongoing": {
            "individual": 0,
            "nonIndividual": 0
          }
        },
        "previousDays": [
          {
            "onceOff": {
              "individual": 0,
              "nonIndividual": 0
            },
            "ongoing": {
              "individual": 0,
              "nonIndividual": 0
            }
          }
        ]
      },
      "revokedAuthorisationCount": {
        "currentDay": {
          "individual": 0,
          "nonIndividual": 0
        },
        "previousDays": [
          {
            "individual": 0,
            "nonIndividual": 0
          }
        ]
      },
      "amendedAuthorisationCount": {
        "currentDay": {
          "individual": 0,
          "nonIndividual": 0
        },
        "previousDays": [
          {
            "individual": 0,
            "nonIndividual": 0
          }
        ]
      },
      "expiredAuthorisationCount": {
        "currentDay": {
          "individual": 0,
          "nonIndividual": 0
        },
        "previousDays": [
          {
            "individual": 0,
            "nonIndividual": 0
          }
        ]
      },
      "abandonedConsentFlowCount": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "abandonmentsByStage": {
        "preIdentification": {
          "currentDay": 0,
          "previousDays": [
            0
          ]
        },
        "preAuthentication": {
          "currentDay": 0,
          "previousDays": [
            0
          ]
        },
        "preAccountSelection": {
          "currentDay": 0,
          "previousDays": [
            0
          ]
        },
        "preAuthorisation": {
          "currentDay": 0,
          "previousDays": [
            0
          ]
        },
        "rejected": {
          "currentDay": 0,
          "previousDays": [
            0
          ]
        },
        "failedTokenExchange": {
          "currentDay": 0,
          "previousDays": [
            0
          ]
        }
      }
    }
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}

Properties

Name	Type	Required	Default	Description
data	object	mandatory		none
» requestTime	DateTimeString	mandatory		The date and time that the metrics in this payload were requested.
» availability	AvailabilityMetricsV2	mandatory		Availability metrics.
» performance	PerformanceMetricsV3	mandatory		Percentage of calls within the performance thresholds in each performance tier, over time.
» invocations	InvocationMetricsV3	mandatory		Number of API calls in each performance tier, over time.
» averageResponse	AverageResponseMetricsV2	mandatory		Average response time in seconds, at millisecond resolution, within each performance tier.
» sessionCount	SessionCountMetricsV2	mandatory		Session counts, over time. Note that a session is defined as the provisioning of an Access Token.
» averageTps	AverageTPSMetricsV2	mandatory		Average transactions per second, over time.
» peakTps	PeakTPSMetricsV2	mandatory		Peak transactions per second, over time.
» errors	ErrorMetricsV2	mandatory		Number of calls resulting in error, over time.
» rejections	RejectionMetricsV3	mandatory		Number of calls rejected due to traffic thresholds, over time.
» customerCount	NaturalNumber	mandatory		Number of customers with active authorisations at the time of the call.
» recipientCount	NaturalNumber	mandatory		Number of Data Recipient Software Products with active authorisations at the time of the call.
» secondaryHolder	SecondaryHolderMetricsV2	conditional		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.
» authorisations	AuthorisationMetricsV2	mandatory		Authorisation counts for the data holder.
links	Links	mandatory		none
meta	Meta	optional		none

AvailabilityMetricsV2

{
  "aggregate": {
    "currentMonth": "string",
    "previousMonths": [
      "string"
    ]
  },
  "unauthenticated": {
    "currentMonth": "string",
    "previousMonths": [
      "string"
    ]
  },
  "authenticated": {
    "currentMonth": "string",
    "previousMonths": [
      "string"
    ]
  }
}

Availability metrics.

Properties

Name	Type	Required	Default	Description
aggregate	object	mandatory		Aggregated availability metrics.
» currentMonth	RateString	conditional		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.
» previousMonths	[RateString]	conditional		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.
unauthenticated	object	mandatory		Availability metrics for the unauthenticated aspects of the CDR regime.
» currentMonth	RateString	conditional		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.
» previousMonths	[RateString]	conditional		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.
authenticated	object	mandatory		Availability metrics for the authenticated aspects of the CDR regime.
» currentMonth	RateString	conditional		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.
» previousMonths	[RateString]	conditional		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.

PerformanceMetricsV3

{
  "aggregate": {
    "currentDay": "string",
    "previousDays": [
      "string"
    ]
  },
  "highPriority": {
    "currentDay": [
      "string"
    ],
    "previousDays": [
      [
        "string"
      ]
    ]
  },
  "largePayload": {
    "currentDay": [
      "string"
    ],
    "previousDays": [
      [
        "string"
      ]
    ]
  },
  "lowPriority": {
    "currentDay": [
      "string"
    ],
    "previousDays": [
      [
        "string"
      ]
    ]
  },
  "unattended": {
    "currentDay": [
      "string"
    ],
    "previousDays": [
      [
        "string"
      ]
    ]
  },
  "unauthenticated": {
    "currentDay": [
      "string"
    ],
    "previousDays": [
      [
        "string"
      ]
    ]
  },
  "secondary": {
    "primary": {
      "currentDay": [
        "string"
      ],
      "previousDays": [
        [
          "string"
        ]
      ]
    },
    "secondary": {
      "currentDay": [
        "string"
      ],
      "previousDays": [
        [
          "string"
        ]
      ]
    }
  },
  "largeSecondary": {
    "primary": {
      "currentDay": [
        "string"
      ],
      "previousDays": [
        [
          "string"
        ]
      ]
    },
    "secondary": {
      "currentDay": [
        "string"
      ],
      "previousDays": [
        [
          "string"
        ]
      ]
    }
  }
}

Percentage of calls within the performance thresholds in each performance tier, over time.

Properties

Name	Type	Required	Default	Description
aggregate	object	optional		Percentage of calls within Primary Data Holder performance thresholds. Note that Secondary Data Holder performance MUST be excluded from this metric.
» currentDay	RateString	conditional		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.
» previousDays	[RateString]	conditional		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.
highPriority	object	mandatory		Percentage of high priority calls within the performance thresholds.
» currentDay	[PerformanceHours]	conditional		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.
» previousDays	[PerformancePreviousDays]	conditional		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.
largePayload	object	mandatory		Percentage of large payload calls within the performance thresholds.
» currentDay	[PerformanceHours]	conditional		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.
» previousDays	[PerformancePreviousDays]	conditional		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.
lowPriority	object	mandatory		Percentage of low priority calls within the performance thresholds.
» currentDay	[PerformanceHours]	conditional		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.
» previousDays	[PerformancePreviousDays]	conditional		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.
unattended	object	mandatory		Percentage of unattended calls within the performance thresholds.
» currentDay	[PerformanceHours]	conditional		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.
» previousDays	[PerformancePreviousDays]	conditional		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.
unauthenticated	object	mandatory		Percentage of unauthenticated calls within the performance thresholds.
» currentDay	[PerformanceHours]	conditional		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.
» previousDays	[PerformancePreviousDays]	conditional		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.
secondary	object	conditional		Percentage of Shared Responsibility calls within the performance thresholds. Mandatory for data holders designated for a Shared Responsibility Data Request data cluster.
» primary	object	mandatory		Percentage of Shared Responsibility calls within the performance thresholds for the primary data holder.
»» currentDay	[PerformanceHours]	conditional		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.
»» previousDays	[PerformancePreviousDays]	conditional		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.
» secondary	object	mandatory		Percentage of Shared Responsibility calls within the performance thresholds for the secondary data holder.
»» currentDay	[PerformanceHours]	conditional		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.
»» previousDays	[PerformancePreviousDays]	conditional		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.
largeSecondary	object	conditional		Percentage of large Shared Responsibility calls within the performance thresholds. Mandatory for data holders designated for a Shared Responsibility Data Request data cluster.
» primary	object	mandatory		Percentage of large Shared Responsibility calls within the performance thresholds for the secondary data holder.
»» currentDay	[PerformanceHours]	conditional		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.
»» previousDays	[PerformancePreviousDays]	conditional		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.
» secondary	object	mandatory		Percentage of large Shared Responsibility calls within the performance thresholds for the secondary data holder.
»» currentDay	[PerformanceHours]	conditional		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.
»» previousDays	[PerformancePreviousDays]	conditional		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.

PerformancePreviousDays

[
  "string"
]

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.

Properties

Name	Type	Required	Default	Description
anonymous	[PerformanceHours]	mandatory		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.

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.

Properties

Name	Type	Required	Default	Description
anonymous	RateString	mandatory		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.

InvocationMetricsV3

{
  "unauthenticated": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "highPriority": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "lowPriority": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "unattended": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "largePayload": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "secondary": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "largeSecondary": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  }
}

Number of API calls in each performance tier, over time.

Properties

Name	Type	Required	Default	Description
unauthenticated	object	mandatory		API call counts for the unauthenticated tier.
» currentDay	NaturalNumber	conditional		API call counts for current day.
» previousDays	[NaturalNumber]	conditional		API call counts for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available.
highPriority	object	mandatory		API call counts for the high priority tier.
» currentDay	NaturalNumber	conditional		API call counts for current day.
» previousDays	[NaturalNumber]	conditional		API call counts for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available.
lowPriority	object	mandatory		API call counts for the low priority tier.
» currentDay	NaturalNumber	conditional		API call counts for current day.
» previousDays	[NaturalNumber]	conditional		API call counts for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available.
unattended	object	mandatory		API call counts for the unattended tier.
» currentDay	NaturalNumber	conditional		API call counts for current day.
» previousDays	[NaturalNumber]	conditional		API call counts for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available.
largePayload	object	mandatory		API call counts for the large payload tier.
» currentDay	NaturalNumber	conditional		API call counts for current day.
» previousDays	[NaturalNumber]	conditional		API call counts for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available.
secondary	object	conditional		API call counts for the Shared Responsibility Data Requests tier. Mandatory for data holders designated for a Shared Responsibility Data Request data cluster.
» currentDay	NaturalNumber	conditional		API call counts for current day.
» previousDays	[NaturalNumber]	conditional		API call counts for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available.
largeSecondary	object	conditional		API call counts for the large Shared Responsibility Data Requests tier. Mandatory for data holders designated for a Shared Responsibility Data Request data cluster.
» currentDay	NaturalNumber	conditional		API call counts for current day.
» previousDays	[NaturalNumber]	conditional		API call counts for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available.

AverageResponseMetricsV2

{
  "unauthenticated": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "highPriority": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "lowPriority": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "unattended": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "largePayload": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "secondary": {
    "primary": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "secondary": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    }
  },
  "largeSecondary": {
    "primary": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "secondary": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    }
  }
}

Average response time in seconds, at millisecond resolution, within each performance tier.

Properties

Name	Type	Required	Default	Description
unauthenticated	object	mandatory		Average response time for the unauthenticated tier.
» currentDay	number	conditional		Average response time for current day.
» previousDays	[number]	conditional		Average response time for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available.
highPriority	object	mandatory		Average response time for the high priority tier.
» currentDay	number	conditional		Average response time for current day.
» previousDays	[number]	conditional		Average response time for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available.
lowPriority	object	mandatory		Average response time for the low priority tier.
» currentDay	number	conditional		Average response time for current day.
» previousDays	[number]	conditional		Average response time for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available.
unattended	object	mandatory		Average response time for the unattended tier.
» currentDay	number	conditional		Average response time for current day.
» previousDays	[number]	conditional		Average response time for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available.
largePayload	object	mandatory		Average response time for the large payload tier.
» currentDay	number	conditional		Average response time for current day.
» previousDays	[number]	conditional		Average response time for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available.
secondary	object	conditional		Average response time for the secondary tier. Mandatory for data holders designated for a Shared Responsibility Data Request data cluster.
» primary	object	mandatory		Average response time as measured for the primary data holder.
»» currentDay	number	conditional		Average response time for current day.
»» previousDays	[number]	conditional		Average response time for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available.
» secondary	object	mandatory		Average response time as measured for the secondary data holder.
»» currentDay	number	conditional		Average response time for current day.
»» previousDays	[number]	conditional		Average response time for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available.
largeSecondary	object	conditional		Average response time for the large payload tier. Mandatory for data holders designated for a Shared Responsibility Data Request data cluster.
» primary	object	mandatory		Average response time as measured for the primary data holder.
»» currentDay	number	conditional		Average response time for current day.
»» previousDays	[number]	conditional		Average response time for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available.
» secondary	object	mandatory		Average response time as measured for the secondary data holder.
»» currentDay	number	conditional		Average response time for current day.
»» previousDays	[number]	conditional		Average response time for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available.

SessionCountMetricsV2

{
  "currentDay": 0,
  "previousDays": [
    0
  ]
}

Session counts, over time. Note that a session is defined as the provisioning of an Access Token.

Properties

Name	Type	Required	Default	Description
currentDay	NaturalNumber	conditional		Session count for current day.
previousDays	[NaturalNumber]	conditional		Session count for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available.

AverageTPSMetricsV2

{
  "aggregate": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "unauthenticated": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "authenticated": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  }
}

Average transactions per second, over time.

Properties

Name	Type	Required	Default	Description
aggregate	object	mandatory		Aggregate average transactions per second, over time, for all endpoints.
» currentDay	number	conditional		Average TPS for current day. Must be a positive value or zero.
» previousDays	[number]	conditional		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.
unauthenticated	object	mandatory		Average transactions per second, over time, for unauthenticated endpoints.
» currentDay	number	conditional		Average TPS for current day. Must be a positive value or zero.
» previousDays	[number]	conditional		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.
authenticated	object	mandatory		Average transactions per second, over time, for authenticated endpoints.
» currentDay	number	conditional		Average TPS for current day. Must be a positive value or zero.
» previousDays	[number]	conditional		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.

PeakTPSMetricsV2

{
  "aggregate": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "unauthenticated": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "authenticated": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  }
}

Peak transactions per second, over time.

Properties

Name	Type	Required	Default	Description
aggregate	object	mandatory		Aggregate peak transactions per second, over time, for all endpoints.
» currentDay	number	conditional		Peak TPS for current day. Must be a positive value or zero.
» previousDays	[number]	conditional		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.
unauthenticated	object	mandatory		Peak transactions per second, over time, for unauthenticated endpoints.
» currentDay	number	conditional		Peak TPS for current day. Must be a positive value or zero.
» previousDays	[number]	conditional		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.
authenticated	object	mandatory		Peak transactions per second, over time, for authenticated endpoints.
» currentDay	number	conditional		Peak TPS for current day. Must be a positive value or zero.
» previousDays	[number]	conditional		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.

ErrorMetricsV2

{
  "aggregate": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "unauthenticated": {
    "currentDay": {
      "500": 0,
      "property1": 0,
      "property2": 0
    },
    "previousDays": [
      {
        "500": 0,
        "property1": 0,
        "property2": 0
      }
    ]
  },
  "authenticated": {
    "currentDay": {
      "500": 0,
      "property1": 0,
      "property2": 0
    },
    "previousDays": [
      {
        "500": 0,
        "property1": 0,
        "property2": 0
      }
    ]
  }
}

Number of calls resulting in error, over time.

Properties

Name	Type	Required	Default	Description
aggregate	object	mandatory		Aggregate number of calls resulting in error due to server execution, over time, for all endpoints.
» currentDay	NaturalNumber	conditional		Error counts for current day.
» previousDays	[NaturalNumber]	conditional		Error counts for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available.
unauthenticated	object	mandatory		Number of calls resulting in error for unauthenticated endpoints.
» currentDay	object	conditional		Error counts, by HTTP error code, for current day.
»» additionalProperties	NaturalNumber	optional		This is a placeholder field to be substituted with each respective HTTP error code in the 4xx and 5xx range recorded by the Data Holder. It is represented by property1 and property2 in the Non-normative Examples section. Note that the property name MUST be the three-digit HTTP error code as per the adjacent 500 example. All possible property names have not been defined as the range is expected to vary across participants. Examples would include, but are not limited to: 400, 404, 405, 406, 415, 422, 429, 500, 503, 504.
»» 500	NaturalNumber	optional		Reflecting the description provided in the adjacent additionalProperties field, this is an example demonstrating the structure for reporting the number of calls resulting in HTTP error code 500. Each error code recorded by the Data Holder in the 4xx and 5xx range MUST be provided in this format against the respective property name.
» previousDays	[object]	conditional		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.
»» additionalProperties	NaturalNumber	optional		This is a placeholder field to be substituted with each respective HTTP error code in the 4xx and 5xx range recorded by the Data Holder. It is represented by property1 and property2 in the Non-normative Examples section. Note that the property name MUST be the three-digit HTTP error code as per the adjacent 500 example. All possible property names have not been defined as the range is expected to vary across participants. Examples would include, but are not limited to: 400, 404, 405, 406, 415, 422, 429, 500, 503, 504.
»» 500	NaturalNumber	optional		Reflecting the description provided in the adjacent additionalProperties field, this is an example demonstrating the structure for reporting the number of calls resulting in HTTP error code 500. Each error code recorded by the Data Holder in the 4xx and 5xx range MUST be provided in this format against the respective property name.
authenticated	object	mandatory		Number of calls resulting in error for authenticated endpoints.
» currentDay	object	conditional		Error counts, by HTTP error code, for current day.
»» additionalProperties	NaturalNumber	optional		This is a placeholder field to be substituted with each respective HTTP error code in the 4xx and 5xx range recorded by the Data Holder. It is represented by property1 and property2 in the Non-normative Examples section. Note that the property name MUST be the three-digit HTTP error code as per the adjacent 500 example. All possible property names have not been defined as the range is expected to vary across participants. Examples would include, but are not limited to: 400, 401, 403, 404, 405, 406, 415, 422, 429, 500, 503, 504.
»» 500	NaturalNumber	optional		Reflecting the description provided in the adjacent additionalProperties field, this is an example demonstrating the structure for reporting the number of calls resulting in HTTP error code 500. Each error code recorded by the Data Holder in the 4xx and 5xx range MUST be provided in this format against the respective property name.
» previousDays	[object]	conditional		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.
»» additionalProperties	NaturalNumber	optional		This is a placeholder field to be substituted with each respective HTTP error code in the 4xx and 5xx range recorded by the Data Holder. It is represented by property1 and property2 in the Non-normative Examples section. Note that the property name MUST be the three-digit HTTP error code as per the adjacent 500 example. All possible property names have not been defined as the range is expected to vary across participants. Examples would include, but are not limited to: 400, 401, 403, 404, 405, 406, 415, 422, 429, 500, 503, 504.
»» 500	NaturalNumber	optional		Reflecting the description provided in the adjacent additionalProperties field, this is an example demonstrating the structure for reporting the number of calls resulting in HTTP error code 500. Each error code recorded by the Data Holder in the 4xx and 5xx range MUST be provided in this format against the respective property name.

RejectionMetricsV3

{
  "authenticated": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "unauthenticated": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  }
}

Number of calls rejected due to traffic thresholds, over time.

Properties

Name	Type	Required	Default	Description
authenticated	object	mandatory		Rejection counts for all authenticated endpoints.
» currentDay	NaturalNumber	conditional		Number of calls rejected for current day.
» previousDays	[NaturalNumber]	conditional		Number of calls rejected for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available.
unauthenticated	object	mandatory		Rejection counts for all unauthenticated endpoints.
» currentDay	NaturalNumber	conditional		Number of calls rejected for current day.
» previousDays	[NaturalNumber]	conditional		Number of calls rejected for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available.

SecondaryHolderMetricsV2

{
  "errors": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "rejections": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  }
}

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.

Properties

Name	Type	Required	Default	Description
errors	object	mandatory		Number of calls resulting in error due to server execution, over time.
» currentDay	NaturalNumber	conditional		Number of errors for current day.
» previousDays	[NaturalNumber]	conditional		Number of errors for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available.
rejections	object	mandatory		Number of calls rejected due to traffic thresholds, over time.
» currentDay	NaturalNumber	conditional		Number of rejections for current day.
» previousDays	[NaturalNumber]	conditional		Number of rejections for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available.

AuthorisationMetricsV2

{
  "activeAuthorisationCount": {
    "individual": 0,
    "nonIndividual": 0
  },
  "newAuthorisationCount": {
    "currentDay": {
      "onceOff": {
        "individual": 0,
        "nonIndividual": 0
      },
      "ongoing": {
        "individual": 0,
        "nonIndividual": 0
      }
    },
    "previousDays": [
      {
        "onceOff": {
          "individual": 0,
          "nonIndividual": 0
        },
        "ongoing": {
          "individual": 0,
          "nonIndividual": 0
        }
      }
    ]
  },
  "revokedAuthorisationCount": {
    "currentDay": {
      "individual": 0,
      "nonIndividual": 0
    },
    "previousDays": [
      {
        "individual": 0,
        "nonIndividual": 0
      }
    ]
  },
  "amendedAuthorisationCount": {
    "currentDay": {
      "individual": 0,
      "nonIndividual": 0
    },
    "previousDays": [
      {
        "individual": 0,
        "nonIndividual": 0
      }
    ]
  },
  "expiredAuthorisationCount": {
    "currentDay": {
      "individual": 0,
      "nonIndividual": 0
    },
    "previousDays": [
      {
        "individual": 0,
        "nonIndividual": 0
      }
    ]
  },
  "abandonedConsentFlowCount": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "abandonmentsByStage": {
    "preIdentification": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "preAuthentication": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "preAccountSelection": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "preAuthorisation": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "rejected": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "failedTokenExchange": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    }
  }
}

Authorisation counts for the data holder.

Properties

Name	Type	Required	Default	Description
activeAuthorisationCount	object	mandatory		The number of active ongoing authorisations.
» individual	NaturalNumber	mandatory		Active ongoing authorisation count for individual customers.
» nonIndividual	NaturalNumber	mandatory		Active ongoing authorisation count for non-individual customers.
newAuthorisationCount	object	mandatory		The number of new authorisations.
» currentDay	object	conditional		Number of new authorisations for the current day.
»» onceOff	object	mandatory		New authorisation count for once-off authorisations.
»»» individual	NaturalNumber	mandatory		New authorisation count for individual customers.
»»» nonIndividual	NaturalNumber	mandatory		New authorisation count for non-individual customers.
»» ongoing	object	mandatory		New authorisation count for ongoing authorisations.
»»» individual	NaturalNumber	mandatory		New authorisation count for individual customers.
»»» nonIndividual	NaturalNumber	mandatory		New authorisation count for non-individual customers.
» previousDays	[object]	conditional		Number of new authorisations for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available.
»» onceOff	object	mandatory		New authorisation count for once-off authorisations.
»»» individual	NaturalNumber	mandatory		New authorisation count for individual customers.
»»» nonIndividual	NaturalNumber	mandatory		New authorisation count for non-individual customers.
»» ongoing	object	mandatory		New authorisation count for ongoing authorisations.
»»» individual	NaturalNumber	mandatory		New authorisation count for individual customers.
»»» nonIndividual	NaturalNumber	mandatory		New authorisation count for non-individual customers.
revokedAuthorisationCount	object	mandatory		The number of revoked authorisations.
» currentDay	object	conditional		Number of revoked authorisations for the current day.
»» individual	NaturalNumber	mandatory		Revoked authorisation count for individual customers.
»» nonIndividual	NaturalNumber	mandatory		Revoked authorisation count for non-individual customers.
» previousDays	[object]	conditional		Number of revoked authorisations for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available.
»» individual	NaturalNumber	mandatory		Revoked authorisation count for individual customers.
»» nonIndividual	NaturalNumber	mandatory		Revoked authorisation count for non-individual customers.
amendedAuthorisationCount	object	mandatory		The number of amended ongoing authorisations.
» currentDay	object	conditional		Number of amended authorisations for the current day.
»» individual	NaturalNumber	mandatory		Amended authorisation count for individual customers.
»» nonIndividual	NaturalNumber	mandatory		Amended authorisation count for non-individual customers.
» previousDays	[object]	conditional		Number of amended authorisations for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available.
»» individual	NaturalNumber	mandatory		Amended authorisation count for individual customers.
»» nonIndividual	NaturalNumber	mandatory		Amended authorisation count for non-individual customers.
expiredAuthorisationCount	object	mandatory		The number of expired ongoing authorisations.
» currentDay	object	conditional		Number of expired authorisations for the current day.
»» individual	NaturalNumber	mandatory		Expired authorisation count for individual customers.
»» nonIndividual	NaturalNumber	mandatory		Expired authorisation count for non-individual customers.
» previousDays	[object]	conditional		Number of expired authorisations for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available.
»» individual	NaturalNumber	mandatory		Expired authorisation count for individual customers.
»» nonIndividual	NaturalNumber	mandatory		Expired authorisation count for non-individual customers.
abandonedConsentFlowCount	object	mandatory		The number of consents flows that were not successfully authorised.
» currentDay	NaturalNumber	conditional		Number of consents flows that were not successfully authorised for the current day.
» previousDays	[NaturalNumber]	conditional		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.
abandonmentsByStage	object	mandatory		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 (i.e. each abandoned consent should assigned to one, and only one, stage).
» preIdentification	object	mandatory		The number of authorisations that commenced with the data holder but the customer did not successfully identify their profile or user ID.
»» currentDay	NaturalNumber	conditional		Number of abandoned consent flows for this stage for the current day.
»» previousDays	[NaturalNumber]	conditional		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.
» preAuthentication	object	mandatory		The number of authorisations where the customer identified themselves (i.e. they successfully identify the customer profile to use for the authorisation) but failed to provide a valid OTP or equivalent.
»» currentDay	NaturalNumber	conditional		Number of abandoned consent flows for this stage for the current day.
»» previousDays	[NaturalNumber]	conditional		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.
» preAccountSelection	object	mandatory		The number of authorisations where the customer successfully authenticated with a valid OTP or equivalent but abandoned the process before selecting accounts.
»» currentDay	NaturalNumber	conditional		Number of abandoned consent flows for this stage for the current day.
»» previousDays	[NaturalNumber]	conditional		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.
» preAuthorisation	object	mandatory		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.
»» currentDay	NaturalNumber	conditional		Number of abandoned consent flows for this stage for the current day.
»» previousDays	[NaturalNumber]	conditional		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.
» rejected	object	mandatory		The number of authorisations where the customer actively rejected the authorisation rather than abandoning the process.
»» currentDay	NaturalNumber	conditional		Number of abandoned consent flows for this stage for the current day.
»» previousDays	[NaturalNumber]	conditional		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.
» failedTokenExchange	object	mandatory		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.
»» currentDay	NaturalNumber	conditional		Number of abandoned consent flows for this stage for the current day.
»» previousDays	[NaturalNumber]	conditional		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.

Links

{
  "self": "string"
}

Properties

Name	Type	Required	Default	Description
self	URIString	mandatory		Fully qualified link to this API call.

Meta

{}

Properties

None

ResponseErrorListV2

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": {
        "urn": "string"
      }
    }
  ]
}

Properties

Name	Type	Required	Default	Description
errors	[ErrorV2]	mandatory		List of errors.

ErrorV2

{
  "code": "string",
  "title": "string",
  "detail": "string",
  "meta": {
    "urn": "string"
  }
}

Properties

Name	Type	Required	Default	Description
code	string	mandatory		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.
title	string	mandatory		A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
detail	string	mandatory		A human-readable explanation specific to this occurrence of the problem.
meta	object	conditional		Additional data for customised error codes.
» urn	string	conditional		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.