Manual

🇩🇪 Diesen Artikel auf Deutsch lesen

Viewing API usage and quotas (API statistics)

On the “API statistics” page you can see how your API connection is being used: the requests over time, your monthly quotas with the current consumption, and a log of the most recent requests. The page is for viewing only – you set up the technical API connection itself together with our customer service.

Requirements

  • An active API connection (a stored API key) for your account. Without an API connection the page cannot be used.
  • The permission to view the API statistics. Additional accesses only see the menu item if this permission has been assigned to them.

If both requirements are met, the “API statistics” menu item appears in the navigation. If the API connection is missing, opening the page shows the notice: “No API connection is set up for your account.”

Step by step

  1. Sign in to the customer portal.
  2. In the left-hand navigation, open the “API statistics” menu item. Alternatively, use the “API quota” tile on the dashboard and the link “View API statistics →” there.
  3. Optional: narrow the charts down to one API type at the top right. In the drop-down, choose “Both APIs”, “Sanctions list API” or “PEP API” and click “Filter”. Use “Reset” to clear the filter again.
  4. Read the quota cards: separately for the “Sanctions list API” and the “PEP API”, you see the current month’s consumption relative to your monthly quota (label: “Requests in the current month / monthly quota”).
  5. Look at the bar charts: “Requests per day (last 30 days)”, “Requests per week (last 12 weeks)” and “Requests per month (last 12 months)”. Hover over a bar to see the period and the number of requests as a tooltip.
  6. In the “API log” section, review the individual requests of the last 60 days with the columns “Time”, “Checked name”, “List”, “Method” and “Result”. The log does not reload automatically – click “Refresh” to load the latest entries.

“API statistics” page with quota cards for the sanctions list and PEP API, bar charts of requests per day, week and month, and the API log table. The “API statistics” page: at the top the quota cards and the type filter, below them the “Requests per day/week/month” charts and the “API log” with the “Refresh” button.

Good to know

  • Data status: the statistics (charts and quotas) go up to the previous day – “Statistics data as of: up to and including yesterday ({datum}) – only complete days are counted. The API log below is live.” Here {datum} stands for yesterday’s date. So the API log is live, while the charts and quotas are updated once a day.
  • Two separate quotas: the sanctions list API and the PEP API are counted separately. The “PEP API” card only appears if the PEP API is used or a PEP quota exists.
  • The type filter only affects the charts: choosing “Sanctions list API” or “PEP API” filters the bar charts. The quota cards always remain visible, split by both API types.
  • API log without auto-reload: the log deliberately shows only a fixed snapshot and does not refresh by itself. You see new requests only after clicking “Refresh”. API requests from the last 60 days are shown.
  • Viewing only: this page displays your API usage. The setup of the API connection (API key, quotas) is handled through our customer service.

Frequently asked questions

Why don’t I see the “API statistics” menu item? The menu item only appears if an API connection (API key) is active for your account and you have permission to view the API statistics. If the API connection is missing, opening the page shows the notice “No API connection is set up for your account.” If you need an API connection, please contact our customer service.

How often are the figures updated? The statistics – that is, the charts and the quota cards – have the data status “up to and including yesterday” and are updated daily; only complete days are counted. The API log is live but does not reload on its own: click “Refresh” to see the latest entries.

What happens when my quota is used up? Please contact our customer service – for example via the chat in the customer portal. We will then clarify the next steps for your API connection together.

Last reviewed: