IBM API Connect Analytics API
Retrieves API event data stored in API Connect Analytics, dashboard data, and the filter parameters supported at cloud, provider organization, catalog and space scope. OpenAPI 3.0, version 2.0.0.
Operations 474
Showing the first 250 of 474. The full set is in the contract, and via get_provider_operations.
GET
/{analytics-service}/cloud/events/{event-id}/context
Get investigation context for an event at cloud scope
#
GET
/{analytics-service}/orgs/{org}/events/{event-id}
Get specific event at provider organization scope
#
GET
/{analytics-service}/orgs/{org}/events/{event-id}/context
Get investigation context for an event at organization scope
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/events/{event-id}
Get specific event at catalog scope
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/events/{event-id}/context
Get investigation context for an event at catalog scope
#
GET
/{analytics-service}/spaces/{org}/{catalog}/{space}/events/{event-id}
Get specific event at space scope
#
GET
/{analytics-service}/spaces/{org}/{catalog}/{space}/events/{event-id}/context
Get investigation context for an event at space scope
#
GET
/{analytics-service}/cloud/discover-timeline
Get the data needed to populate the Timeline chart in discover view at cloud…
#
GET
/{analytics-service}/orgs/{org}/discover-timeline
Get the data needed to populate the Timeline chart in discover view at org scope
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/discover-timeline
Get the data needed to populate the Timeline chart in discover view at catalog…
#
GET
/{analytics-service}/spaces/{org}/{catalog}/{space}/discover-timeline
Get the data needed to populate the Timeline chart in discover view at space…
#
GET
/{analytics-service}/cloud/dashboards/api
Get the data needed to populate the API dashboard at cloud scope
#
GET
/{analytics-service}/cloud/dashboards/application
Get the data needed to populate the Application dashboard at cloud scope
#
GET
/{analytics-service}/cloud/dashboards/consumer
Get the data needed to populate the Consumer dashboard at cloud scope
#
GET
/{analytics-service}/cloud/dashboards/gateway
Get the data needed to populate the Gateway Operations dashboard at cloud scope
#
GET
/{analytics-service}/cloud/dashboards/latency
Get the data needed to populate the Latency dashboard at cloud scope
#
GET
/{analytics-service}/cloud/dashboards/client
Get the data needed to populate the Client dashboard at cloud scope
#
GET
/{analytics-service}/cloud/dashboards/client/worldmap
Get the data needed to populate the worldmap dashboard at cloud scope
#
GET
/{analytics-service}/cloud/dashboards/mcp
Get the data needed to populate the MCP dashboard at cloud scope
#
GET
/{analytics-service}/cloud/dashboards/product
Get the data needed to populate the Product dashboard at cloud scope
#
GET
/{analytics-service}/cloud/dashboards/status
Get the data needed to populate the Status dashboard at cloud scope
#
GET
/{analytics-service}/cloud/dashboards/summary
Get the data needed to populate the SUMMARY dashboard at cloud scope
#
GET
/{analytics-service}/cloud/dashboards/consumption
Get the data needed to populate the Consumption dashboard at cloud scope
#
GET
/{analytics-service}/cloud/dashboards/data
Get the data needed to populate the Data dashboard at cloud scope
#
GET
/{analytics-service}/cloud/dashboards/ai
Get the data needed to populate the AI LLM dashboard at cloud scope
#
GET
/{analytics-service}/cloud/dashboards/api-backend
Get the data needed to populate the Backend dashboard at cloud scope
#
GET
/{analytics-service}/cloud/status-code-mismatch
Get the paginated list of status code mismatch events at cloud scope
#
GET
/{analytics-service}/cloud/policy-errors
Get the paginated list of policy error events at cloud scope
#
GET
/{analytics-service}/orgs/{org}/dashboards/api
Get the data needed to populate the API dashboard at provider organization scope
#
GET
/{analytics-service}/orgs/{org}/dashboards/application
Get the data needed to populate the Application dashboard at provider…
#
GET
/{analytics-service}/orgs/{org}/dashboards/consumer
Get the data needed to populate the Consumer dashboard at provider organization…
#
GET
/{analytics-service}/orgs/{org}/dashboards/gateway
Get the data needed to populate the Gateway Operations dashboard at provider…
#
GET
/{analytics-service}/orgs/{org}/dashboards/latency
Get the data needed to populate the Latency dashboard at provider organization…
#
GET
/{analytics-service}/orgs/{org}/dashboards/client
Get the data needed to populate the Client dashboard at provider organization…
#
GET
/{analytics-service}/orgs/{org}/dashboards/client/worldmap
Get the data needed to populate the worldmap at client dashboard at provider…
#
GET
/{analytics-service}/orgs/{org}/dashboards/mcp
Get the data needed to populate the MCP dashboard at org scope
#
GET
/{analytics-service}/orgs/{org}/dashboards/product
Get the data needed to populate the Product dashboard at provider organization…
#
GET
/{analytics-service}/orgs/{org}/dashboards/status
Get the data needed to populate the Status dashboard at provider organization…
#
GET
/{analytics-service}/orgs/{org}/dashboards/summary
Get the data needed to populate the SUMMARY dashboard at provider organization…
#
GET
/{analytics-service}/orgs/{org}/dashboards/consumption
Get the data needed to populate the Consumption dashboard at provider…
#
GET
/{analytics-service}/orgs/{org}/dashboards/data
Get the data needed to populate the Data dashboard at provider organization…
#
GET
/{analytics-service}/orgs/{org}/dashboards/ai
Get the data needed to populate the AI LLM dashboard at provider organization…
#
GET
/{analytics-service}/orgs/{org}/dashboards/api-backend
Get the data needed to populate the Backend dashboard at provider organization…
#
GET
/{analytics-service}/orgs/{org}/status-code-mismatch
Get the paginated list of status code mismatch events at provider organization…
#
GET
/{analytics-service}/orgs/{org}/policy-errors
Get the paginated list of policy error events at provider organization scope
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/dashboards/api
Get the data needed to populate the API dashboard at catalog scope
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/dashboards/application
Get the data needed to populate the Application dashboard at catalog scope
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/dashboards/consumer
Get the data needed to populate the Consumer dashboard at catalog scope
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/dashboards/gateway
Get the data needed to populate the Gateway Operations dashboard at catalog…
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/dashboards/latency
Get the data needed to populate the Latency dashboard at catalog scope
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/dashboards/client
Get the data needed to populate the Client dashboard at catalog scope
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/dashboards/client/worldmap
Get the data needed to populate the worldmap at client dashboard at catalog…
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/dashboards/mcp
Get the data needed to populate the MCP dashboard at catalog scope
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/dashboards/product
Get the data needed to populate the Product dashboard at catalog scope
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/dashboards/status
Get the data needed to populate the Status dashboard at catalog scope
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/dashboards/summary
Get the data needed to populate the SUMMARY dashboard at catalog scope
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/dashboards/consumption
Get the data needed to populate the Consumption dashboard at catalog scope
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/dashboards/data
Get the data needed to populate the Data dashboard at catalog scope
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/dashboards/ai
Get the data needed to populate the AI LLM dashboard at catalog scope
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/dashboards/api-backend
Get the data needed to populate the Backend dashboard at catalog scope
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/status-code-mismatch
Get the paginated list of status code mismatch events at catalog scope
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/policy-errors
Get the paginated list of policy error events at catalog scope
#
GET
/{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/api
Get the data needed to populate the API dashboard at space scope
#
GET
/{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/application
Get the data needed to populate the Application dashboard at space scope
#
GET
/{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/consumer
Get the data needed to populate the Consumer dashboard at space scope
#
GET
/{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/gateway
Get the data needed to populate the Gateway Operations dashboard at space scope
#
GET
/{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/latency
Get the data needed to populate the Latency dashboard at space scope
#
GET
/{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/client
Get the data needed to populate the Client dashboard at space scope
#
GET
/{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/client/worldmap
Get the data needed to populate the worldmap at client dashboard at space scope
#
GET
/{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/mcp
Get the data needed to populate the MCP dashboard at space scope
#
GET
/{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/product
Get the data needed to populate the Product dashboard at space scope
#
GET
/{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/status
Get the data needed to populate the Status dashboard at space scope
#
GET
/{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/summary
Get the data needed to populate the SUMMARY dashboard at space scope
#
GET
/{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/consumption
Get the data needed to populate the Consumption dashboard at space scope
#
GET
/{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/data
Get the data needed to populate the Data dashboard at space scope
#
GET
/{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/ai
Get the data needed to populate the AI LLM dashboard at space scope
#
GET
/{analytics-service}/spaces/{org}/{catalog}/{space}/dashboards/api-backend
Get the data needed to populate the Backend dashboard at space scope
#
GET
/{analytics-service}/spaces/{org}/{catalog}/{space}/status-code-mismatch
Get the paginated list of status code mismatch events at space scope
#
GET
/{analytics-service}/spaces/{org}/{catalog}/{space}/policy-errors
Get the paginated list of policy error events at space scope
#
GET
/{analytics-service}/cloud/filterparameters
List of filter parameters supported at cloud scope
#
GET
/{analytics-service}/orgs/{org}/filterparameters
List of filter parameters supported at provider organization scope
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/filterparameters
List of filter parameters supported at catalog scope
#
GET
/{analytics-service}/spaces/{org}/{catalog}/{space}/filterparameters
List of filter parameters supported at space scope
#
GET
/{analytics-service}/orgs/{org}/runtime-metrics
Runtime metrics at provider organization scope
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/runtime-metrics
Runtime metrics at catalog scope
#
POST
/{analytics-service}/cloud/queries/{query-id}/transfer-owner
Transfer ownership of a saved query to a different user
#
POST
/{analytics-service}/cloud/queries/{query-id}/default
Set a shared query as the default query
#
GET
/{analytics-service}/orgs/{org}/queries/current-default
List current default query at org scope
#
DELETE
/{analytics-service}/orgs/{org}/queries/{query-id}
Deletes the specified query at org scope
#
POST
/{analytics-service}/orgs/{org}/queries/{query-id}/transfer-owner
Transfer ownership of a saved query to a different user
#
POST
/{analytics-service}/orgs/{org}/queries/{query-id}/clone
Make a personal copy of a shared query
#
POST
/{analytics-service}/orgs/{org}/queries/{query-id}/default
Set a shared query as the default query
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/queries/shared
List shared queries at catalog scope
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/queries/current-default
List current default query at catalog scope
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/queries/{query-id}
Get a specific query at catalog scope
#
PUT
/{analytics-service}/catalogs/{org}/{catalog}/queries/{query-id}
Update a specific query at catalog scope
#
DELETE
/{analytics-service}/catalogs/{org}/{catalog}/queries/{query-id}
Deletes the specified query at catalog scope
#
POST
/{analytics-service}/catalogs/{org}/{catalog}/queries/{query-id}/transfer-owner
Transfer ownership of a saved query to a different user
#
POST
/{analytics-service}/catalogs/{org}/{catalog}/queries/{query-id}/unshare
Unshare a saved query
#
POST
/{analytics-service}/catalogs/{org}/{catalog}/queries/{query-id}/clone
Make a personal copy of a shared query
#
POST
/{analytics-service}/catalogs/{org}/{catalog}/queries/{query-id}/default
Set a shared query as the default query
#
GET
/{analytics-service}/spaces/{org}/{catalog}/{space}/queries/shared
List shared queries at space scope
#
GET
/{analytics-service}/spaces/{org}/{catalog}/{space}/queries/current-default
List current default query at space scope
#
GET
/{analytics-service}/spaces/{org}/{catalog}/{space}/queries/{query-id}
Get a specific query at space scope
#
PUT
/{analytics-service}/spaces/{org}/{catalog}/{space}/queries/{query-id}
Update a specific query at space scope
#
DELETE
/{analytics-service}/spaces/{org}/{catalog}/{space}/queries/{query-id}
Deletes the specified query at space scope
#
POST
/{analytics-service}/spaces/{org}/{catalog}/{space}/queries/{query-id}/transfer-owner
Transfer ownership of a saved query to a different user
#
POST
/{analytics-service}/spaces/{org}/{catalog}/{space}/queries/{query-id}/share
Share a saved query
#
POST
/{analytics-service}/spaces/{org}/{catalog}/{space}/queries/{query-id}/unshare
Unshare a saved query
#
POST
/{analytics-service}/spaces/{org}/{catalog}/{space}/queries/{query-id}/clone
Make a personal copy of a shared query
#
POST
/{analytics-service}/spaces/{org}/{catalog}/{space}/queries/{query-id}/default
Set a shared query as the default query
#
GET
/{analytics-service}/orgs/{org}/service-status
Used by the UI to get the analytics service status
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/service-status
Used by the UI to get the analytics service status
#
GET
/{analytics-service}/spaces/{org}/{catalog}/{space}/service-status
Used by the UI to get the analytics service status
#
POST
/{analytics-service}/catalogs/{org}/{catalog}/config-sync-data
Send data to analytics on the usage of config-sync
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/corgs/{corg}/dashboard
Get data needed to populate the consumer analytics dashboard
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/corgs/{corg}/apps/{app}/dashboard
Get data to populate the consumer analytics dashboard by app id
#
GET
/{analytics-service}/cloud/reports/apiusage/mini-leaderboards/apis
API usage report API leaderboard
#
GET
/{analytics-service}/cloud/reports/apiusage/mini-leaderboards/products
API usage report product leaderboard
#
GET
/{analytics-service}/cloud/reports/apiusage/mini-leaderboards/plans
API usage report plan leaderboard
#
GET
/{analytics-service}/cloud/reports/leaderboards/products
Get the data needed to populate the Products leaderboard
#
GET
/{analytics-service}/cloud/reports/leaderboards/aiplatform-providers
AI platform providers leaderboard
#
GET
/{analytics-service}/cloud/reports/leaderboards/plans
Get the data needed to populate the Plans leaderboard
#
GET
/{analytics-service}/cloud/reports/leaderboards/consumerorgs
Consumer organization leaderboard
#
GET
/{analytics-service}/cloud/reports/leaderboards/aiplatform-consumers
AI platform consumers leaderboard
#
GET
/{analytics-service}/cloud/reports/gateway-services/{gateway-service-name}
Gateway service detail report
#
GET
/{analytics-service}/cloud/reports/inactive/consumerorgs/{inactive-consumer-report-type}
Inactive consumer orgs report table
#
GET
/{analytics-service}/cloud/reports/inactive/products/{inactive-product-report-type}
Inactive product report table
#
GET
/{analytics-service}/cloud/reports/consumertrend/mini-leaderboards/applications
Consumer trend report application leaderboard
#
GET
/{analytics-service}/cloud/reports/consumertrend/mini-leaderboards/consumerorgs
Consumer trend report consumer org leaderboard
#
GET
/{analytics-service}/cloud/reports/consumerorgs/{consumer-org-name}
Consumer org detail report
#
GET
/{analytics-service}/cloud/reports/usage-evolution/{usage-evolution-report-type}
Usage Evolution report
#
GET
/{analytics-service}/cloud/reports/aiplatform/mini-leaderboards/aiplatform-providers
AI Platform provider leaderboard
#
GET
/{analytics-service}/cloud/reports/aiplatform/mini-leaderboards/aiplatform-consumers
AI Platform consumer leaderboard
#
GET
/{analytics-service}/orgs/{org}/reports/apiusage/mini-leaderboards/apis
API usage report API leaderboard
#
GET
/{analytics-service}/orgs/{org}/reports/apiusage/mini-leaderboards/products
API usage report product leaderboard
#
GET
/{analytics-service}/orgs/{org}/reports/apiusage/mini-leaderboards/plans
API usage report plan leaderboard
#
GET
/{analytics-service}/orgs/{org}/reports/leaderboards/aiplatform-providers
AI platform providers leaderboard
#
GET
/{analytics-service}/orgs/{org}/reports/leaderboards/plans
Get the data needed to populate the Plans leaderboard
#
GET
/{analytics-service}/orgs/{org}/reports/leaderboards/consumerorgs
Consumer organization leaderboard
#
GET
/{analytics-service}/orgs/{org}/reports/leaderboards/aiplatform-consumers
AI platform consumers leaderboard
#
GET
/{analytics-service}/orgs/{org}/reports/leaderboards/gateway-services
Gateway services leaderboard
#
GET
/{analytics-service}/orgs/{org}/reports/gateway-services/{gateway-service-name}
Gateway service detail report
#
GET
/{analytics-service}/orgs/{org}/reports/inactive/consumerorgs
Inactive consumer orgs report funnel
#
GET
/{analytics-service}/orgs/{org}/reports/inactive/consumerorgs/{inactive-consumer-report-type}
Inactive consumer orgs report table
#
GET
/{analytics-service}/orgs/{org}/reports/inactive/products/{inactive-product-report-type}
Inactive product report table
#
GET
/{analytics-service}/orgs/{org}/reports/consumertrend/mini-leaderboards/applications
Consumer trend report application leaderboard
#
GET
/{analytics-service}/orgs/{org}/reports/consumertrend/mini-leaderboards/consumerorgs
Consumer trend report consumer org leaderboard
#
GET
/{analytics-service}/orgs/{org}/reports/consumerorgs/{consumer-org-name}
Consumer org detail report
#
GET
/{analytics-service}/orgs/{org}/reports/usage-evolution/{usage-evolution-report-type}
Usage Evolution report
#
GET
/{analytics-service}/orgs/{org}/reports/aiplatform/mini-leaderboards/aiplatform-providers
AI Platform provider leaderboard
#
GET
/{analytics-service}/orgs/{org}/reports/aiplatform/mini-leaderboards/aiplatform-consumers
AI Platform consumer leaderboard
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/reports/apiusage/mini-leaderboards/apis
API usage report API mini-leaderboard
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/reports/apiusage/mini-leaderboards/products
API usage report product mini-leaderboard
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/reports/apiusage/mini-leaderboards/plans
API usage report plan mini-leaderboard
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/reports/products/{productref}
Product detail report
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/reports/mcpservers/{mcpserverref}
MCP Server detail report
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/reports/leaderboards/products
Product leaderboard
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/reports/leaderboards/aiplatform-providers
AI platform providers leaderboard
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/reports/leaderboards/applications
Application leaderboard
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/reports/leaderboards/consumerorgs
Consumer organization leaderboard
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/reports/leaderboards/aiplatform-consumers
AI platform consumers leaderboard
#
GET
/{analytics-service}/catalogs/{org}/{catalog}/reports/leaderboards/breakdown
Breakdown leaderboard
#
Documentation
📖
Documentation
https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=reference-api-connect-rest-apis
📖
GettingStarted
https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=reference-api-connect-rest-apis
📖
Authentication
https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=cli-managing-platform-rest-api-keys
📖
Documentation
https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=ui-analytics-rest-api