With the growing need for long-term visibility into API usage and performance, analytics long-term summary data was introduced in API Connect v10.0.8. This allowed key metrics like latency, status codes, and data transfer volumes to be retained far longer than detailed API event records.

But what's the difference between event data and summary data?

• API event data is detailed and includes 50+ attributes per invocation. It's intended for problem determination and debugging, but typically retained for only a few days or weeks, depending on your retention policy.

• Summary data includes just around 10 core metrics, but it’s retained for a year or more, making it ideal for long-term trend analysis, performance monitoring, and strategic insights.

However, until now, there was no way to directly extract the raw summary data for use in external tools or workflows.

Introducing the summary analytics APIs

Now available in v10.0.10, the new Summary APIs allow teams to directly access long-term summary event data, making it easy to extract, filter, and use this information within their own tools, dashboards, or automated workflows.

These APIs surface key metrics for every API invocation, such as:

• Latency (time_to_serve_request)

• Status codes

• Bytes sent and received

• Application and organisation metadata

What you can do with summary APIs

• Analyse trends over time: Track patterns in latency, traffic, and errors across weeks or months to optimise API performance and reliability.

• Troubleshoot more effectively: Investigate issues even after raw analytics event data has rolled over.

• Give support teams a broader view: Support teams can now access a wider historical view, making it easier to correlate spikes in latency or failures with system changes or client behaviour.

Sample summary record

Here’s what a summary event record looks like:

{
  "api_ref": "switch-api:1.0.0",
  "app_name": "api-connect-app-4",
  "bytes_received": 888,
  "bytes_sent": 9177,
  "catalog_name": "api-connect-catalog-1",
  "datetime": "2025-06-11T04:00:00.000Z",
  "developer_org_name": "api-connect-emard-greenholt-awesome-fantastic-consumer-organization",
  "gateway_service_name": "v6gw",
  "org_name": "ibm",
  "plan_id": "api-connect-crooks-group-luxurious-tasty-rubber-chair-product:1.0.0:default-plan",
  "product_ref": "api-connect-crooks-group-luxurious-tasty-rubber-chair-product:1.0.0",
  "space_name": null,
  "status_code": "201 Created",
  "summary_event_id": "A11ybP3Dnla5jttwIQuGjA",
  "time_to_serve_request": 571
}

Available operations

All API operations support filtering, pagination, and timeframe selection, so you can easily query the data you need whether by application name, organisation name, status code, or timeframe. These operations are also available via the API Connect Toolkit CLI.

Supported API paths

The Summary APIs can be queried at different scopes:

Cloud scope:

• GET /{analytics-service}/cloud/summary

• GET /{analytics-service}/cloud/summary/{summary-event-id}

• GET /{analytics-service}/cloud/summary/count

Org scope:

• GET /{analytics-service}/orgs/{org}/summary

• GET /{analytics-service}/orgs/{org}/summary/{summary-event-id}

• GET /{analytics-service}/orgs/{org}/summary/count

Catalog scope:

• GET /{analytics-service}/catalogs/{org}/{catalog}/summary

• GET /{analytics-service}/catalogs/{org}/{catalog}/summary/{summary-event-id}

• GET /{analytics-service}/catalogs/{org}/{catalog}/summary/count

Space scope:

• GET /{analytics-service}/spaces/{org}/{catalog}/{space}/summary

• GET /{analytics-service}/spaces/{org}/{catalog}/{space}/summary/{summary-event-id}

• GET /{analytics-service}/spaces/{org}/{catalog}/{space}/summary/count

API documentation:

See the complete list of operations, filter parameters, and usage examples here:

API Connect v10 Summary API documentation

With summary APIs in API Connect 10.0.10, teams gain long-term visibility into API usage, making it easier to analyse performance and drive smarter operations.

This functionality will be coming soon to version 10.0.8.3 as well.