Usage Monitoring UI
From the Usage Monitoring page of the SBS portal, you can perform the following actions:
- View statistics about how frequently SBS Services are being called (the so-called “Metrics”). Metrics report the number of queries or mutations that were run for each SBS service, within a custom date range that you specify.
- View usage (billing counters) of selected SBS Services. Currently, the following SBS services have billing counters: e-Factura, e-Transport, Tax Declarations, and Online Banking. Like metrics, usage is reported for a custom range that you specify.
- Filter, search and sort metrics and usage data. For example, you can filter usage by a date range, or by the SBS environment where usage occurred (test or production).
Access
You can access the Usage Monitoring page of the portal as follows:
- Sign in to the SBS Portal. During the sign-in process, you will be prompted to select the account, app, and tenant where you are entitled to sign in.
- Click usage-monitoring-api in the left hand-side menu.
To interact with the Usage Monitoring service, you can use either the Web UI or a GraphQL interface. You can switch at any time between the two interfaces by clicking the switch displayed at the top of the page:
All the actions available to you in the portal are based on the permissions assigned by your supervisor. This applies both to the Web UI and the GraphQL interfaces.
Viewing metrics
To view statistics about how frequently SBS services are being called:
- Click the Metrics tab at the top of the page (this tab is selected by default when you enter the Usage Monitoring page).
- Select a service from the adjacent drop-down list.
- Optionally, adjust the date range. The date range selected by default is the current month (from the 1st of the current month up to and including today).
- Click View.
Viewing usage
Currently, usage data are available for the following services and measurement types:
| Service | Usage Measurement Type | Meaning |
|---|---|---|
| e-Factura Service | INBOUND_INVOICES | The number of incoming (inbound) invoices received within the reported period. |
| e-Transport Service | UIT | The number of shipment identification numbers (UIT) created within the reported period. |
| Online Banking | BALANCE_INQUIRY | The number of successful balance inquiries within the reported period. |
| Online Banking | TRANSACTIONS_INQUIRY | The number of successful transaction inquiries that took place within the reported period. |
| Tax Declarations | CSV_FILE_LINES | The number of processed CSV lines (by tax declarations generated successfully) within the reported period. |
To view usage of a particular SBS service:
- Click the Usage tab at the top of the page.
- Select a service from the adjacent drop-down list. The drop-down list contains only services where usage is tracked.
- Select a usage measurement type (counter name).
- Optionally, adjust the date range. The date range selected by default is the current month (from the 1st of the current month up to and including today).
- If applicable, select the SBS Environment for which you would like to view usage. By default, PRODUCTION is selected.
The environment dropdown list is visible only if you have selected a service that has test and production environments (such as e-Factura Service, e-Transport Service, Online Banking Service)
- Click View.