Custom Report

You can drill down to specific API metrics and visualize the exact data based on your business requirements using custom reports. Select the metrics, group if needed, and limit the data based on your criteria using filters.
Create and visualize custom charts as panels. You can create up to three panels. Each panel includes the following fields, which you can customize:
  • Title and Description
  • Metric
  • Dimensional filters
  • Time filters
You can group or ungroup each dimensional filter. Each grouped dimensional filter only filters the data based on your selections. However, each ungrouped dimensional filter is represented on the chart as a line.
After you save the custom reports,
API Portal
retains the report information upon browser refresh or subsequent login. You can modify the charts later as needed.
You can retrieve the insights that are visualized in
API Portal
using the Metrics Query API. For more information about this API, see Metrics Query API.
From the menu bar, select
Monitor,
Custom Report
to access this report.
Select
Export
on the top-right corner to export the custom charts.
Create a Panel on Custom Report
For example, you can customize your analytics reports to filter or group API hits by API key.
Follow these steps:
  1. Click
    Add Panel
    on the
    Custom Report
    page.
    The Chart Metric panel opens.
  2. Select the chart metric from the drop-down. By default, the
    API Hits
    chart metric is selected.
  3. Select the data source for which you want to create the chart, and then select
    Apply
    .
    Click
    All Data
    to fetch all the data.
    You can select from the following dimensional filters on the right-side of the panel to further drill-down data. Selecting any dimension from the right-side panel reflects visually on the left-side of the panel. Each line on the left-side of the panel represents the data flow of a line on the final chart.
    • API:
      Select APIs by Name or Rank.
    • Application:
      Select Applications by Name or Rank.
      The applications that are displayed are those that consume the APIs owned by the Org Publisher's organization.
    • Proxy:
      Select Gateway Server by Name or Rank.
      The proxies that are displayed are those that are visible to the Org Publisher's organization.
    • Organization:
      Select Organizations by Name or Rank.
      The organizations that are displayed are those that consume the APIs owned by the Org Publisher's organization.
    • Response Code:
      Select Response Code by Rank, Range, or HTTP Status Code.
    • URI:
      Select URI by Rank or Expression.
      If a URI pattern is a superset of any of the subsequent patterns, then the API returns the values only for the superset pattern.
      • Example:
        If URI based hits are:
        • /accounts/v1 - 5
        • /accounts/v1/acc1 - 2
        • /accounts/v1/acc2 - 2
        • /accounts/v1/acc1/transactions - 3
        • /accounts/v1/acc2/transactions - 4
        • /accounts/v1/acc1/transactions/transc1 - 3
        • /accounts/v1/acc1/transactions/transc2 - 5
        • /accounts/v1/acc2/transactions/transc1 - 4
        • /accounts/v1/acc2/transactions/transc2 - 3
      • Typical URI patterns that can be derived and their values:
        • /accounts/v1 - 5
        • /accounts/v1/[w] - 4
        • /accounts/v1/[w]/transactions - 7
        • /accounts/v1/acc1/transactions/[x] - 8
        • /accounts/v1/[w]/transactions/[x] - 15
    • API Key:
      Select API key by Name or Rank. You can retrieve analytics such as:
      • Data for an API key.
      • Consumption of the API keys for an application.
      • Consumption of an API from all API keys.
      • Consumption of an API from the API keys for an application.
      • Consumption of an API key for an application against an API.
      • Consumption of all API keys for an application against an API.
      The API keys that display are those for their own organization as well as those for the applications that are managed by the Org Publisher's organization.
      Analytics for Multiple API Keys
      (Hybrid customers only)
      If you have metrics enabled (you are tracking analytics) and you are managing multiple API keys for your application, to have
      API Portal
      properly reflect and record the analytics for all API keys including the default key, update the Portal integration software on the API proxy.
      For more information:
      • Select the
        Grouped
        checkbox to group multiple entities of a data source; this also results in a single line chart for the grouped entities. For detailed information, see the following section "
        Group Data on a Custom Report"
        .
      • Select
        Remove
        to delete the selected filter.
      The Chart Data Limit shows the number of entities that you selected. You can select a maximum of
      three ungrouped
      entities.
      Limit:
      10
  4. Create the chart with the selected data source filter by selecting
    Get Data
    .
  5. Stack filters to further drill-down the data based on your requirements. Click the data source to open the Chart Metric panel, and then select the next filter.
  6. Click
    Apply
    , and then plot a chart representing data based on the stacked data sources by selecting
    Get Data
    .
    The line chart is plotted.
  7. Edit the chart title and description to reflect the information that is plotted on the chart.
  8. To view the data points, hover over the line chart or the legend. Details about your selections are displayed as tool-tips.
  9. To edit a selection, click the corresponding data source or time range tile.
Group Data on a Custom Report
You can group multiple entities of a data source to represent it as a single line on the Custom Report line chart by selecting the
Grouped
checkbox. This helps in summarizing and visualizing large data to derive meaningful information.
By default, the selection appears as an individual line on the chart. The number of rows you see in the Chart Metric panel is the number of lines that are plotted in the line chart. You can group data only when you have selected a data source based on Name.
Example Custom Report without Grouped Data:
Example Custom Report with Grouped Data: