1 1. Hub Datasets
- 1.1 1.1 Raw API Log Data
- 1.2 1.2 API Call Volume & Billing
- 1.3 1.3 Performance
- 1.4 1.4 Availability
  - 1.4.1 1.4.1 OFP Availability
  - 1.4.2 1.4.2 LFI Availability
- 1.5 1.5 Consents
  - 1.5.1 1.5.1 Consent Authorisation
  - 1.5.2 1.5.2 Consent Status
  - 1.5.3 1.5.3 Consent Revocations
  - 1.5.4 1.5.4 Consent Users
- 1.6 1.6 Usage & Uptake
  - 1.6.1 1.6.1 Account Information
  - 1.6.2 1.6.2 Payments
    - 1.6.2.1 Payment Volume
    - 1.6.2.2 Payments Value
    - 1.6.2.3 Payments Performance
  - 1.6.3 1.6.3 Usage - Other
- 1.7 1.7 Event Notifications
2 2. LFI Reports
- 2.1 2.1 Admin Portal Dashboard Widgets
- 2.2 2.2 Pre-configured Reports
- 2.3 2.3 Dynamic Reports
  - 2.3.1 2.3.1 API Call Volume & Billing
  - 2.3.2 2.3.2 Performance
3 3. TPP Reports
- 3.1 3.1 API Call Volume & Billing
- 3.2 3.2 Performance

1. Hub Datasets

The OFP will provide hub-level consolidated data to Mercury.

Other than the API Log dataset (which consists of “raw” data for each API call), the datasets below will provide a “roll-up” consolidation for each day.

1.1 Raw API Log Data

Field	Description	Data type
timestamp	Timestamp when the API call was received	Datetime
LFI Org Id	Identifiers (such as name, orgId) of the Licensed Financial Institution	String
TPP Org Id	Identifiers (such as name, clientid, orgId) of the TPP	String
API Set	Group of APIs (e.g. account information, payments, vrp etc.) An API can belong to only one group that will be determined as part of the specifications.	Enumeration
HTTP Method	The technical `method` that was used for the API call. The methods supported for each API call are specified in the standard.	Enumeration
URL	The generic `url template` for the API call. (This is the url without any url parameters specified)	Enumeration
HTTP Response Code Group	The response code group for the API calls `2xx` (successful) `4xx` (Rejected with client error) `5xx` (Failed with server error)	Enumeration
Execution time	Time in (ms) required to execute the API	Integer (ms)
interaction id	Unique identifier for this api call	String (uuidv4)

1.2 API Call Volume & Billing

This dataset provides the API call volumes

Field	Description	Data type
Period Start	Date-time when the reporting period started	Datetime
Period End	Date-time when the reporting period ended	Datetime
LFI Org Id	Identifiers (such as name, orgId) of the Licensed Financial Institution	String
TPP Org Id	Identifiers (such as name, clientid, orgId) of the TPP	String
API Set	Group of APIs (e.g. account information, payments, vrp etc.) An API can belong to only one group that will be determined as part of the specifications.	Enumeration
HTTP Method	The technical `method` that was used for the API call. The methods supported for each API call are specified in the standard.	Enumeration
URL	The generic `url template` for the API call. (This is the url without any url parameters specified)	Enumeration
HTTP Response Code Group	The response code group for the API calls `2xx` (successful) `4xx` (Rejected with client error) `5xx` (Failed with server error)	Enumeration
Total number of calls	Count of API calls	Integer (count)

1.3 Performance

This dataset minimum, maximum and average time taken for API calls

Field	Description	Data type
Period Start	Date-time when the reporting period started	Datetime
Period End	Date-time when the reporting period ended	Datetime
LFI Org Id	Identifiers (such as name, orgId) of the Licensed Financial Institution	String
TPP Org Id	Identifiers (such as name, clientid, orgId) of the TPP	String
API Set	Group of APIs (e.g. account information, payments, vrp etc.) An API can belong to only one group that will be determined as part of the specifications.	Enumeration
HTTP Method	The technical `method` that was used for the API call. The methods supported for each API call are specified in the standard.	Enumeration
URL	The generic `url template` for the API call. (This is the url without any url parameters specified)	Enumeration
HTTP Response Code Group	The response code group for the API calls `2xx` (successful) `4xx` (Rejected with client error) `5xx` (Failed with server error)	Enumeration
Max Response time	The maximum response time from start to finish for responding to the API	integer (ms)
Min Response time	The minimum response time from start to finish for responding to the API	integer (ms)
Average Response time	The average response time from start to finish for responding to the API	integer (ms)
Max LFI Response time	The maximum response time used by the LFI to responsd to OFP requests for the API	integer (ms)
Min LFI Response time	The minimum response time used by the LFI to responsd to OFP requests for the API	integer (ms)
Average LFI Response time	The average response time used by the LFI to responsd to OFP requests for the API	integer (ms)

1.4 Availability

1.4.1 OFP Availability

Provides information of planned and unplanned downtime of the OFP.

Field	Description	Data type
Period Start	Date-time when the reporting period started	Datetime
Period End	Date-time when the reporting period ended	Datetime
LFI Org Id	Identifiers (such as name, orgId) of the Licensed Financial Institution	String
Total Time	The total number of minutes in the given time period of the report	Integer (minutes)
Total Uptime	The number of minutes of uptime in the given time period.	Integer (minutes)
Planned Downtime	The total number of minutes that were scheduled as downtime in the time period	Integer (minutes)
Unplanned Downtime	The percentage of time that the OFP was unavailable for use or not functioning correctly during a period when downtime was not planned	Integer (minutes)
Total Downtime	`Total Downtime = Planned Downtime - Unplanned Downtime` `Total Downtime = Total Time - Total Uptime`	Integer (minutes)
% Uptime	The percentage of time that the OFP was available for use and functioning correctly. `% Uptime = Total Uptime / Total Time`	Integer (percentage)
% Downtime	The percentage of time that the OFP was unavailable for use or not functioning correctly `% Downtime = Total Downtime / Total Time`	Integer (percentage)
% Unplanned Downtime	The percentage of time that the OFP was unavailable for use in the time period excluding planned downtime `% Unplanned Downtime = Total Downtime / (Total Time - Planned Downtime)`	Integer (percentage)

1.4.2 LFI Availability

Provides information of planned and unplanned downtime of the LFI’s Ozone Connect interface.

Field	Description	Data type
Period Start	Date-time when the reporting period started	Datetime
Period End	Date-time when the reporting period ended	Datetime
LFI Org Id	Identifiers (such as name, orgId) of the Licensed Financial Institution	String
Total Time	The total number of minutes in the given time period of the report	Integer (minutes)
Total Uptime	The number of minutes of uptime in the given time period.	Integer (minutes)
Planned Downtime	The total number of minutes that were scheduled as downtime in the time period	Integer (minutes)
Unplanned Downtime	The percentage of time that the LFI’s Ozone Connect interface was unavailable for use or not functioning correctly during a period when downtime was not planned	Integer (minutes)
Total Downtime	`Total Downtime = Planned Downtime - Unplanned Downtime` `Total Downtime = Total Time - Total Uptime`	Integer (minutes)
% Uptime	The percentage of time that the LFI’s Ozone Connect was available for use and functioning correctly. `% Uptime = Total Uptime / Total Time`	Integer (percentage)
% Downtime	The percentage of time that the LFI’s Ozone Connect was unavailable for use or not functioning correctly `% Downtime = Total Downtime / Total Time`	Integer (percentage)
% Unplanned Downtime	The percentage of time that the OFP was unavailable for use in the time period excluding planned downtime `% Unplanned Downtime = Total Downtime / (Total Time - Planned Downtime)`	String

1.5 Consents

1.5.1 Consent Authorisation

This report provides data on the state of new consents during the given time period.

The report provides data as observed by the OFP. Data observed by the LFI may differ as redirects back to the TPP may success or fail.

The fields may change as the Consent state model is finalised in the standard

Field	Description	Datatype
Period Start	Date-time when the reporting period started	Datetime
Period End	Date-time when the reporting period ended	Datetime
LFI Org Id	Identifiers (such as name, orgId) of the Licensed Financial Institution	String
TPP Org Id	Identifiers (such as name, clientid, orgId) of the TPP	String
Authentication channel	App, Web	Enumeration
Consent type	The type of consent (e.g. payments, accounts)	Enumeration
Authorised Consents at Start Date	Total number of consents in an `Authorised` state at the start of the reporting period	Integer (count)
Authorised Consents at End Date	Total number of consents in an `Authorised` state at the end of the reporting period This is computed as `Authorised Consents at Start Date + Successful Authorisations - Consent Revocations - Consent Consumptions - Consent Expirations`	Integer (count)
Consents Created	Total number of new consents that were created during the reporting period. (This is the number of `par` requests made to the OFP authorization server during the reporting period)	Integer (count)
Authorisation Requests	Total number of authorization requests (This is the number of `auth` requests made to the OFP Headless Heimdall service during the reporting period.)	Integer (count)
Successful Authorisation Requests	Total number of authorisation requests that were successful (Requests to `auth` that ended with `2xx` code	Integer (count)
Unsuccessful Authorisation Requests	Total number of authorisation requests that were not successful (Requests to `auth` that ended with non `2xx` code)	Integer (count)
Completed Authorisations	Total number of authorization requests that were completed with a success or error. (This is the number of `doFail` or `doSuccess` requests made to the OFP Headless Heimdall service.)	Integer (count)
Incomplete Authorisations	Authorisations that were started, but never completed ( `Authorisation Requests` - `Completed Authorisations`)	Integer (count)
Abandoned Authorisations	Consents for which a corresponding authorisation request was never made ( `Consents Created` - `Authorisation Requests`)	Integer (count)
Insecure Authorisation Requests	Total number of authorization requests that were completed, but without a redirect to the TPP as the TPP could not be identified. (This is the number of `auth` or `doFail` requests that resulted in a `redirect: false` response)	Integer (count)
Successful Authorisations	Total number of authorisation requests that were completed and resulted in the generation of an authorization code (This is measured as the number of `doSuccess` calls that resulted in a successful response)	Integer (count)
Unsuccessful Authorisations	Total number of authorisation requests that were unsuccessful (This is measured as the number of `doFail` calls and `doSuccess` calls that resulted in a non 200 response that resulted in a successful response)	Integer (count)
Access Denied Errors	Number of consents for which the customer denied authorisation explicitly. (This is measured as the number of `doFail` calls with an `error_code` of `access_denied`)	Integer (count)
Other Unsuccessful Authorisations	Number of Unsuccessful Authorisations ending with an error other than `access_denied`	Integer (count)
Consent Rejections	Number of consents that were `Rejected` during the reporting period This is the sum of Abandoned Auth Requests Unsuccesful Authorisation Requests Insecure Authorisation Requests Incomplete Authorisations Unsuccessful Authorisation Requests	Integer (count)
Consent Revocations	Number of consents that transitioned into `Revoked` state during the reporting period	Integer (count)
Consent Consumptions	Number of consents that transitioned into `Consumed` state during the reporting period	Integer (count)
Consent Expirations	Number of consents that transitioned into `Expired` state during the reporting period	Integer (count)

The figure below illustrates the breakup of consents created by stage of progression through the authorisation process

1.5.2 Consent Status

Field	Description	Datatype
Period Start	Date-time when the reporting period started	Datetime
Period End	Date-time when the reporting period ended	Datetime
LFI Org Id	Identifiers (such as name, orgId) of the Licensed Financial Institution	String
TPP Org Id	Identifiers (such as name, clientid, orgId) of the TPP	String
Authentication channel	App, Web	Enumeration
Consent type	The type of consent (e.g. payments, accounts)	Enumeration
Consent State	The consent state that this record relates to	Enumeration
Count at start	Number of consents in the given consent state at the start of the period	Integer (count)
Count at end	Number of consents in the given consent state at the end of the period	Integer (count)

1.5.3 Consent Revocations

Field	Description	Datatype
Period Start	Date-time when the reporting period started	Datetime
Period End	Date-time when the reporting period ended	Datetime
LFI Org Id	Identifiers (such as name, orgId) of the Licensed Financial Institution	String
TPP Org Id	Identifiers (such as name, clientid, orgId) of the TPP	String
Authentication channel	App, Web	Enumeration
Consent type	The type of consent (e.g. payments, accounts)	Enumeration
Revocation Reason Code	The reason code for the consent revocation for the given row	Enumeration
Count	Number of consents revoked with the revocation reason code during the period	Integer (count)

1.5.4 Consent Users

Field	Description	Datatype

Field	Description	Datatype
Period Start	Date-time when the reporting period started	Datetime
Period End	Date-time when the reporting period ended	Datetime
LFI Org Id	Identifiers (such as name, orgId) of the Licensed Financial Institution	String
TPP Org Id	Identifiers (such as name, clientid, orgId) of the TPP	String
Authentication channel	App, Web	Enumeration
Consent type	The type of consent (e.g. payments, accounts)	Enumeration
Unique User Count at Start	Total number of unique users at the start of the period associated with `Authorised` consents	Integer (count)
Unique User Count at End	Total number of unique users at the end of the period associated with `Authorised` consents	Integer (count)
Change in user base	`Uniqu User Count at End - Unique User Count at Start`	Integer (count)

1.6 Usage & Uptake

1.6.1 Account Information

Field	Description	Data type
Period Start	Date-time when the reporting period started	Datetime
Period End	Date-time when the reporting period ended	Datetime
LFI Org Id	Identifiers (such as name, orgId) of the Licensed Financial Institution	String
TPP Org Id	Identifiers (such as name, clientid, orgId) of the TPP	String
Resource Name	Balance, Transactions, Direct debit, etc.	Enumeration
Status	HTTP Status code for the request	No
Total Requests	The number of combined successful / unsuccessful API requests during the selected reporting time period.	Integer (count)
Rows	Number of “rows” of information for successful requests	Integer (count)

1.6.2 Payments

Payment Volume

Field	Description	Data type
Period Start	Date-time when the reporting period started	Datetime
Period End	Date-time when the reporting period ended	Datetime
LFI Org Id	Identifiers (such as name, orgId) of the Licensed Financial Institution	String
TPP Org Id	Identifiers (such as name, clientid, orgId) of the TPP	String
Payment type	Payments SIP, Payments VRP, etc.	Enumeration
Currency	The currency of the payment executed.	String
POST Request Count	The number of payments API `post` requests during the reporting time period. This excludes API calls for retrieving payment statuses, consent status, confirmation of funds etc	Integer (count)
Successful POST Request Count	The number of successful payments API `post` requests during the reporting time period.	Integer (count)
Failed POST Request Count	The number of failed payments API `post` requests during the reporting time period.	Integer (count)
Completed Payment Count	The number of payments that have been completed (fully settled)	Integer (count)
Failed Payment Count	The number of payments that failed to be settled	Integer (count)
Incomplete Payment Count	The number of payments that are incomplete (neither failed, nor settled)	Integer (count)

Payments Value

Field	Description	Data type
Period Start	Date-time when the reporting period started	Datetime
Period End	Date-time when the reporting period ended	Datetime
LFI Org Id	Identifiers (such as name, orgId) of the Licensed Financial Institution	String
TPP Org Id	Identifiers (such as name, clientid, orgId) of the TPP	String
Payment type	Payments SIP, Payments VRP, etc.	Enumeration
Currency	The currency of the payment executed.	String
POST Request Value	The number of payments API `post` requests during the reporting time period. This excludes API calls for retrieving payment statuses, consent status, confirmation of funds etc	Decimal (count)
Successful POST Request Value	The number of successful payments API `post` requests during the reporting time period.	Decimal (count)
Failed POST Request Value	The number of failed payments API `post` requests during the reporting time period.	Decimal (count)
Completed Payment Value	The number of payments that have been completed (fully settled)	Decimal (count)
Failed Payment Value	The number of payments that failed to be settled	Decimal (count)
Incomplete Payment Value	The number of payments that are incomplete (neither failed, nor settled)	Decimal (count)

Payments Performance

Field	Description	Data type
Period Start	Date-time when the reporting period started	Datetime
Period End	Date-time when the reporting period ended	Datetime
LFI Org Id	Identifiers (such as name, orgId) of the Licensed Financial Institution	String
TPP Org Id	Identifiers (such as name, clientid, orgId) of the TPP	String
Payment type	Payments SIP, Payments VRP, etc.	Enumeration
Currency	The currency of the payment executed.	String
Average API Call Response Time	The average time in ms taken by the payment API call	Integer (ms)
Maximum API Call Response Time	The maximum time in ms taken by the payment API call	Integer (ms)
Minimum API Call Response Time	The minimum time in ms taken by the payment API call	Integer (ms)
Average Payment processing time	The average time in ms taken between the creation of the payment record on the OFP and the receipt of the final settlement confirmation or failure event from the LFI	Integer (ms)
Maximum Payment processing time	The maximum time in ms taken between the creation of the payment record on the OFP and the receipt of the final settlement confirmation or failure event from the LFI	Integer (ms)
Minimum Payment processing time	The minimum time in ms taken between the creation of the payment record on the OFP and the receipt of the final settlement confirmation or failure event from the LFI	Integer (ms)

1.6.3 Usage - Other

Additional usage reports will be added as new standards are introduced

1.7 Event Notifications

Field	Description	Data type
Period Start	Date-time when the reporting period started	Datetime
Period End	Date-time when the reporting period ended	Datetime
LFI Org Id	Identifiers (such as name, orgId) of the Licensed Financial Institution	String
TPP Org Id	Identifiers (such as name, clientid, orgId) of the TPP	String
API Set	Group of APIs (e.g. account information, payments, vrp etc.) An API can belong to only one group that will be determined as part of the specifications.	Enumeration
Event Name	The event name that was delivered to the TPP	Enumeration
HTTP Response Code Group	The response code group received back from the TPP `2xx` (successful) `4xx` (Rejected with client error) `5xx` (Failed with server error)	Enumeration
Total number of calls	Count of API calls	Integer (count)

2. LFI Reports

2.1 Admin Portal Dashboard Widgets

<TODO>

This section identifies the widgets that will be provided on the admin portal dashboard to provide an overview of the current performance and state of the OFP for a given LFI

2.2 Pre-configured Reports

<TODO>

2.3 Dynamic Reports

For each of the reports below, the LFI will be able to:

select the time range for which they want to generate the report
Select the time period over which they want to “roll up” the information
Select the fields they want to group the information by
Select the fields they want to filter the information by

2.3.1 API Call Volume & Billing

This dataset provides the API call volumes.

Field	Description	Datatype	Filter	Group

Field	Description	Datatype	Filter	Group
Period Start	Date-time when the rollup period started	Datetime	NA	NA
Period End	Date-time when the rollup period ended	Datetime	NA	NA
LFI Org Id	Identifiers (such as name, orgId) of the Licensed Financial Institution	String	Yes	Yes
TPP Org Id	Identifiers (such as name, clientid, orgId) of the TPP	String	Yes	Yes
API Set	Group of APIs (e.g. account information, payments, vrp etc.) An API can belong to only one group that will be determined as part of the specifications.	Enumeration	Yes	Yes
HTTP Method	The technical `method` that was used for the API call. The methods supported for each API call are specified in the standard.	Enumeration	Yes	Yes
URL	The generic `url template` for the API call. (This is the url without any url parameters specified)	Enumeration	Yes	Yes
HTTP Response Code Group	The response code group for the API calls `2xx` (successful) `4xx` (Rejected with client error) `5xx` (Failed with server error)	Enumeration	Yes	Yes
Total number of calls	Count of API calls	Integer (count)	No	No

2.3.2 Performance