API Usage Specific Report Templates
CentraSite pre-ships few report templates designed for API usage reporting. These templates allow the CentraSite users and API-Portal users to generate API usage specific reports, and to monitor and manage the usage of their APIs and their consumers.
The API usage reports show the number of requests made by all consumers of an API over a specific period of time. The reports are distributed as an email attachment, in PDF format, to the user at the email address provided at registration. The user then clicks the attachment to access the API usage data.
By default, the API usage reports are shared with any API-Portal instance that is registered in CentraSite.
However, if you have a custom report template for API usage reporting, then you must have this template shared with the required instance of
API-Portal. For instructions on how to share a report template with
API-Portal, see
Sharing Reports with
API-Portal.
The API usage report templates in CentraSite include:
API Invocations (daily) - When you generate the API Invocations report for a user over a reporting date, the report displays the number of requests made by each application of that particular user for the selected API during the specified reporting date.
API Invocations (weekly) - When you generate the API Invocations report for a user over a reporting week, the report displays the number of requests made by each application of that particular user for the selected API during the specified reporting week.
API Invocations (monthly) - When you generate the API Invocations report for a user over a reporting month, the report displays the number of requests made by each application of that particular user for the selected API during the specified reporting month.
