Details on export API usage on the Workspace level
Path: Workspace Homepage >> Apps Icon >> Reporting >> Export data >> Export API Usage
This export provides a straightforward overview of all APIs used within your workspace communities, including details on their usage and connections. It equips administrators with the insights needed to monitor API activity, understand integration points, and see how these APIs contribute to the platform’s functionality.
Output format: Idea data can be exported in the following formats
-
Microsoft Excel sheet (.xls) format
-
CSV
Community: Workspace admin can export API usage data for all communities within the workspace using All option or a specific community.
Type: The data can be exported for MCP, Others (Slack, AI) or All of them.
Data Filters: Specify the start date and the end date to download data for a specific period of time. To export all data from the beginning to the current date then click on Hide Date Filters.
Select your timezone: You may select your preferred timezone for viewing the exported data, allowing for a more personalized experience instead of adhering to the community's default timezone.
Upon clicking the Export data button, the export process will begin and become available for download.
The following fields are included in the Excel file:
ID: It includes the API action ID.
Community Name: The name of the community the API was used for.
Member Name: Display name of the member who used the API.
Timestamp: Date and time when the API was used. It appears in MM/DD/YYYY HH:MM format.
IP Address: The IP address from where the API was used.
URL: URL: The specific endpoint accessed during the API call. This helps identify whether data was retrieved from sources like Slack, IdeaScale AI, the MCP server, or API tools such as Postman.
For Example:/a/rest/v1/ - Indicate API was used via REST API app like Postman or MCP servers./a/rest/chat/ - Indicate the API was used via a chat app like Slack./a/rest/backend/v1/ - Indicate the API was used via a backend API like IdeaScale AI.
Remote System Info: System: Identifies which platform or tool accessed the API, such as Slack, IdeaScale AI, the MCP server, or API applications like Postman.
For Example:
User-Agent: Java/21.0.5 - Indicate the API was used by a chat app like Slack
User-Agent: axios/1.7.7 - Indicate the API was used by IdeaScale AI
User-Agent: ideascale-mcp-server/1.0.0 - Indicate the API was used by MCP servers like Claude or Cursor IDE
User-Agent: PostmanRuntime/7.43.3 - Indicate the API was used by a REST API app like Postman.