TPP Dataset

1 1. Available Datasets
- 1.1 1.1 API Call Volume & Billing
- 1.2 1.2 OFP Availability
- 1.3 1.3 LFI Availability
- 1.4 1.4 OFP Performance
- 1.5 1.4 LFI Performance

Source: The following reports will be made available through an API for TPPs.

1. Available Datasets

1.1 API Call Volume & Billing

This dataset provides the daily API call volumes:

Field	Description	Data type
Datetime	The date for which this report applies.	Datetime
LFI Id	Identifier of the Licensed Financial Institution	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.2 OFP Availability

Field	Description	Data type	Filter
Period Start	Date-time when the reporting period started.	Datetime	N/A
Period End	Date-time when the reporting period ended.	Datetime	N/A
LFI Id	Identifier of the Licensed Financial Institution	String	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
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
URL	The generic `url template` for the API call. (This is the url without any url parameters specified.)	Enumeration	Yes
Total Time	The total number of minutes in the given time period of the report.	Integer (minutes)	No
Total Uptime	The number of minutes of uptime in the given time period.	Integer (minutes)	No
Planned Downtime	The total number of minutes that were scheduled as downtime in the time period.	Integer (minutes)	No
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)	No
Total Downtime	`Total Downtime = Planned Downtime - Unplanned Downtime` `Total Downtime = Total Time - Total Uptime`	Integer (minutes)	No
% Uptime	The percentage of time that the OFP was available for use and functioning correctly. `% Uptime = Total Uptime / Total Time`	Integer (percentage)	No
% Downtime	The percentage of time that the OFP was unavailable for use or not functioning correctly. `% Downtime = Total Downtime / Total Time`	Integer (percentage)	No
% 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)	No

1.3 LFI Availability

Field	Description	Data type	Filter
Period Start	Date-time when the reporting period started.	Datetime	N/A
Period End	Date-time when the reporting period ended.	Datetime	N/A
LFI Id	Identifier of the Licensed Financial Institution	String	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
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
URL	The generic `url template` for the API call. (This is the url without any url parameters specified.)	Enumeration	Yes
Total Time	The total number of minutes in the given time period of the report.	Integer (minutes)	No
Total Uptime	The number of minutes of uptime in the given time period.	Integer (minutes)	No
Planned Downtime	The total number of minutes that were scheduled as downtime in the time period.	Integer (minutes)	No
Unplanned Downtime	The total number of minutes that the LFI’s Ozone Connect was unavailable for use or not functioning correctly during a period when downtime was not planned.	Integer (minutes)	No
Total Downtime	`Total Downtime = Planned Downtime - Unplanned Downtime` `Total Downtime = Total Time - Total Uptime`	Integer (minutes)	No
% 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)	No
% 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)	No
% Unplanned Downtime	The percentage of time that the LFI’s was unavailable for use in the time period excluding planned downtime. `% Unplanned Downtime = Total Downtime / (Total Time - Planned Downtime)`	Integer (percentage)	No

1.4 OFP Performance

Field	Description	Data type	Filter
Period Start	Date-time when the reporting period started.	Datetime	N/A
Period End	Date-time when the reporting period ended.	Datetime	N/A
LFI Id	Identifier of the Licensed Financial Institution	String	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
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
URL	The generic `url template` for the API call. (This is the url without any url parameters specified).	Enumeration	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
Max Response time	The maximum response time used by the OFP to respond to TPP requests for the API.	integer (ms)	No
Min Response time	The minimum response time used by the OFP to respond to TPP requests for the API.	integer (ms)	No
Average Response time	The average response time used by the OFP to respond to TPP requests for the API.	integer (ms)	No
Total number of calls	Count of API calls.	Integer (count)	No
Error rate	`5xx` / Total number of calls = Error rate.	Integer (percentage)	No

1.4 LFI Performance

This dataset provides minimum, maximum and average time taken for API calls for a given day:

Field	Description	Data type	Filter
Period Start	Date-time when the reporting period started.	Datetime	N/A
Period End	Date-time when the reporting period ended.	Datetime	N/A
LFI Id	Identifier of the Licensed Financial Institution	String	Yes
API Set	Group of APIs (e.g. account information, payments, VRPs etc). An API can belong to only one group that will be determined as part of the specifications.	Enumeration	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
URL	The generic `url template` for the API call. (This is the url without any url parameters specified).	Enumeration	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
Max Response time	The maximum response time used by the LFI to respond to OFP requests for the API.	integer (ms)	No
Min Response time	The minimum response time used by the LFI to respond to OFP requests for the API.	integer (ms)	No
Average Response time	The average response time used by the LFI to respond to OFP requests for the API.	integer (ms)	No
Total number of calls	Count of API calls.	Integer (count)	No
Error rate	`5xx` / Total number of calls = Error rate.	Integer (percentage)	No

API Hub Documentation v5

This space is deprecated and no longer supported. Please use the latest available version here.