The Rest API section in the Datahub Portal provides a dashboard to view and analyze an organization’s usage of Rest API.
The dashboard provides valuable insights into the performance, reliability, usage, and impact of API’s within a system or application. These metrics enable developers and stakeholders to monitor, troubleshoot, and optimize the API integration experience.
The dashboard provides details in the following tabs:
- Organizational overview: Displays an overview of all API calls
- API calls: Lists all the API transactions per method and status
- Top endpoints: Lists the API calls that are most used for the selected period
- Failed endpoints: Lists the failed API calls for the selected period
Organizational overview #
The organizational overview provides an overview of all used API calls within an organization.
In the Datahub Portal module > click Rest API 
. The Rest API metrics page is displayed.
The Organizational overview tab includes the following sections:
The topbar displays various metrics, depending on the selected method, status and time period.
Legend name |
Description |
|---|---|
Success rate |
The percentage of successfull API calls |
Error rate |
The percentage of failed API calls |
Total calls |
The total number of API calls |
Successfull calls |
The total number of successfull API calls |
Failed calls |
The total number of failed API calls |
Average response time |
The mean duration it takes for an API to process a collection of requests and return their corresponding responses to the client |
Values for each metric are displayed for the selected method, status and duration.
The chart provides a graphical representation of Total API calls / Successful calls / Failed calls
Duration
View the API details for the selected period. Use the toggle buttons in the upper rigt corner to switch periods: day, week (default), month, quarter, year.
- By default, webhook details are displayed for the current week.
Use the Method and Status dropdown list to specify the API method (DELETE, GET, POST, PUT, …) or Status (200, 400, 500, …) you would like to visualize in the graph.
API calls #
The administrator can view API call details, such as API endpoint (URL), subscription name, batch ID, and elapsed time.
In the Datahub Portal module > click Webhook > click the Webhook calls tab. The webhook call details are displayed.
Available columns
Column |
Description |
|---|---|
Date and time |
Date and time when the API call was created |
Status code |
Http response status code |
Method |
ALL / DELETE / GET / PATCH / POST / PUT |
Module |
SCALAR module that used the API call |
Base URL |
Primary, consistent address or entry point used by an API client to connect to the hosting server. |
Endpoint |
The total time required for a request to be sent and a response to be received from the destination server |
Elapsed time |
It measures the total time taken to process an API request from start to finish. |
Response size |
API response size |
Integrator |
Integrator name through which the data is transmitted |
API call details #
Click an API call in the list to display its details in a separate screen:
Top endpoints #
The Top endpoints tab provides an overview of the top 5 most used API calls for the selected period.
Failed endpoints #
The Failed endpoints tab provides an overview of the top 5 most failed API calls for the selected period.
Filter API calls #
You can filter webhook call details based on the duration.
- In the Datahub Portal module > click Rest API > click API calls tab. The API call details are displayed.
- Click Filters and then select the required option: by date, by method, by module or by integrator . The records are filtered. In the tabs Top endpoints and Failed endpoints, you can only filter by date.
- To clear the applied filter criteria, click Reset all.
- To close the filter pane, click Close
. - When filtering by date, select Custom to set a specific date range by clicking the start and end date in the date picker:
.
