Create custom reports to track API calls based on services, routes, or
Note: If you select multiple service versions in a report, the report
shows the sum of requests for all selected versions broken down by service.
It does not show data points for individual service versions.
View custom reports
To access all custom reports, open
Analytics from the left-side menu in Konnect, then Reports.
This brings you to a list of all custom reports in the organization.
Click on any report in the table to view it. From the report’s details page, you
can export, edit, or delete the report.
Create a custom report
To set up a new report, open Analytics, click Reports, then follow these steps:
- Click the New Report button.
Name the report and optionally add a description.
The name and description fields each have a 255 character limit.
Choose a time frame to display.
You can choose a preset time frame ranging from 1 day to 1 year, or
select Custom to set any date range.
All time frames are static. The report will capture a snapshot of data
in whichever time frame you choose, but the range always stops at the time
that the report was created. You can see a preview of the exact range below
the time frame selector. For example:
Sunday, Jun 12, 9:57:45 AM (CEST) to Monday, Jun 13, 9:57:45 AM (CEST)
Choose a report type.
- Service Report: Generate a report based on services cataloged in Service Hub.
- Route Report: Generate a report based on routes.
- Application Report: Generate a report based on applications registered on your Dev Portal.
Depending on the report type you choose, the available metrics and entities
- Choose a metric to group the data by.
Choose the entities to focus on in your report.
Route entity names are composed of multiple elements.
See route entity format for the breakdown.
- Click Create to open the report details page.
From the report details page you can:
- View details: Hover over a bar on the graph to see details about the data.
- Filter the graph: Click on an item in the legend to temporarily hide it from view,
and click it again to show the item. The graph resets on a refresh.
Export a custom report
You can export any custom report in CSV format.
To export a report, open Analytics, click Reports, then follow these steps:
- Click on a report row to open the report’s page.
- From the Actions dropdown, select Export Report.
Konnect generates a CSV file download with all the data in the report.
Edit a custom report
To edit a report, open Analytics, click Reports, then choose one of following options:
- Click the
settings icon for a report row and select Edit.
- Click on a report row to open the report. In the Actions dropdown menu,
select Edit Report.
Make your changes and click Update.
You may have to refresh the page to see the updated report.
Delete a custom report
To delete a report, open Analytics, click Reports, then choose one of following options:
- Click the
settings icon for a report row, select Delete, then confirm deletion in the dialog.
- Click on a report row to open the report. From the Actions dropdown menu,
select Delete Report, then confirm deletion in the dialog.
Each metric depends on a time frame and a primary entity (report type).
||Service, route, application
||Total number of API calls within the selected time frame.
|Total traffic by status code
||Service, route, application
||Number of API calls grouped by status code.
|Total traffic by service
||Number of API calls filtered by services or service versions and grouped by service.
|Total traffic by route
||Number of API calls grouped by route.
|Total traffic by application
||Number of API calls grouped by application.
Route entity format
In custom reports, the route entity name is composed of the following elements:
KONNECT_SERVICE_NAME.VERSION.ROUTE_NAME|FIRST_FIVE_UUID_CHARS (RUNTIME GROUP)
For example, for a route entity named
example_service.v1.example_route with the badge
example_service is the Konnect service name
v1 is the service version
example_route is the route name
default is the runtime group name
Or, if your route doesn’t have a name, it might look like this:
DA58B are the first five characters of its UUID.
Export historical data in CSV format through the
Service Hub for any individual service, service version, or route.