Summary API event record field reference

Summary API event records are retained for longer durations than individual event records.

Summary API event record fields

Table 1 shows examples of the fields that are stored in a Summary API event record.

Table 1. API event record fields
Field name	Type	Description
api_ref	String	The API reference (api_name:api_version)
app_name	String	The name of the registered application. Note: The property is set to `undefined` when a client ID is not used or is invalid on the API. The gateway needs a client ID to determine which app was invoking the API. From this app, the gateway can determine what plan the app is subscribed to on the product that contains the API. Without a client ID, the gateway is cannot determine which plan, product, or app was invoked. This is because a single API can belong to multiple products, each of which have multiple plans and apps that are subscribed to those plans with client IDs.
bytes_received	Number	The number of bytes received from the consumer in the request.
bytes_sent	Number	The number of bytes sent to the consumer in the response.
catalog_name	String	The name of the catalog
datetime	Date	A timestamp that records when the API was invoked. The timestamp is always shown in Coordinated Universal Time.
developer_org_name	String	The name of the consumer organization that owns the application.
gateway_service_name	String	The name of the DataPower® API gateway service. Configured by the cloud admin during gateway service registration. Only available on DataPower API Gateway v10.5.3 or higher.
org_name	String	The name of the provider organization that owns the API and associated Products.
plan_id	String	The Plan identifier.
product_ref	String	The product reference (product_name:product_version)
space_name	String	The space name for products that are published to a space
status_code	String	The status code set on the outbound response.
summary_event_id	String	Unique ID assigned to the event
time_to_serve_request	Number	The time elapsed (in milliseconds) from when the gateway received the request to when it sent a response

Example Summary Event Record

{
            "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-soft-sausages-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
        }

Use the following operations to retrieve analytics summary event data with the API Connect Analytics REST API:

Table 2. Operations to retrieve analytics summary event data
Operation	Description
GET /summary	This operation returns a list of summary event records.
GET /summary/:id	This operation returns a specific summary event record by its unique ID.
GET /summary/count	This operation returns the total number of summary event records.

Note: These operations are also present within the Analytics CLI in Toolkit.