Versions Compared

Version Old Version 3 New Version 4
Changes made by

Chris Wood

Chris Wood

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Set the Period Start Date parameter to indicate the start date for the data to be returned.

  • Set the Period End Data parameter to indicate the end date for the data to be returned.

  • Optional Optionally set the Report Type parameter to only return one of the available report data sets.

...

Code Block
HTTP/1.1 200 OK
Content-type: application/json
x-fapi-interaction-id: 86b446a7-b2de-4615-8731-167df9e64336
{
  "Data": [
    {
      "Type": "API Call Volume",
      "ReportingPeriodDate": "2019-01-01",
      "LfiId": "c6b2288a-29c8-4a89-b982-33059da8f420",
      "LfiName": "Example LFI 1",
      "ApiSet": "BankDataSharing",
      "HttpMethod": "GET",
      "Url": "/open-finance/bank-data-sharing/v1.0-rc2/accounts",
      "HttpResponseCodeGroup": "2xx",
      "TotalCalls": 100002
    },
    {
      "Type": "API Call Volume",
      "ReportingPeriodDate": "2019-01-01",
      "LfiId": "f15f38d7-157d-41e4-b712-d1d0b114098d",
      "LfiName": "Example LFI 1",
      "ApiSet": "BankServiceInitiation",
      "HttpMethod": "POST",
      "Url": "/open-finance/bank-service-initiation/v1.0-rc2/payments",
      "HttpResponseCodeGroup": "2xx",
      "TotalCalls": 50
    },
    ...
  ],
  "Links": {
    "Self": "http://example.com",
    "First": "http://example.com",
    "Prev": "http://example.com",
    "Next": "http://example.com",
    "Last": "http://example.com"
  },
  "Meta": {}
}
  ],
  "Links": {
    "Self": "https://admin.openfinanceplatform.ae/open-finance/reporting/v1.0-rc2/tpp-reports?PeriodStartDate=2025-01-01&PeriodEndDate=2025-01-21&ReportType=API+Call+Volume"
  },
  "Meta": {}
}

...

  • Unsigned responses are provided for this API. Signed responses are not supported.

  • For clarity, each report line can be uniquely identified based on a composite key using the following components:

    • Type

    • ReportingPeriodDate OR (PeriodStartDate and PeriodEndDate).

    • LfiId

    • APISet

    • HttpMethod

    • Url

    • Where included, HttpResponseCodeGroup

  • The parameters PeriodStartDate and PeriodEndDate are inclusive.

  • Pages for the report data will be returned based on the default OFP page size.