Resumen de referencia de campo de registro de eventos API

Los registros de eventos API resumidos se conservan durante más tiempo que los registros de eventos individuales.

Resumen de los campos de registro de eventos de la API

La Tabla 1 muestra ejemplos de los campos que se almacenan en un registro de eventos de la API de resumen.

Tabla 1. Campos de registro de suceso de API
Nombre de campo Tipo Descripción
api_ref Serie La referencia de la API (api_name:api_version)
nombre_aplic Serie El nombre de la aplicación registrada.
Nota: La propiedad se establece en undefined cuando un ID de cliente no se utiliza o no es válido en la API. La pasarela necesita un ID de cliente para determinar qué aplicación ha invocado la API. Desde esta aplicación, la pasarela puede determinar a qué plan está suscrita la aplicación en el producto que contiene la API. Sin un ID de cliente, la pasarela no puede determinar qué plan, producto o aplicación se ha invocado. Esto se debe a que una sola API puede pertenecer a varios productos, cada uno de los cuales tiene varios planes y aplicaciones que están suscritas a esos planes con ID de cliente.
BYTES_RECEIVED Número El número de bytes recibidos del consumidor en la solicitud.
Bytes_Sent Número El número de bytes enviados al consumidor en la respuesta.
nombre_catálogo Serie El nombre del catálogo
fecha y hora Fecha Una marca de tiempo que registra cuándo se invocó la API. La marca de tiempo se muestra siempre en Tiempo Universal Coordinado.
nombre_org_desarrollador Serie Nombre de la organización de consumidores propietaria de la aplicación.
nombre_servicio_pasarela Serie El nombre del servicio de la pasarela API DataPower®. Configurado por el administrador de la nube durante el registro del servicio de pasarela. Sólo disponible en DataPower API Gateway v10.5.3 o superior.
org_name Serie Nombre de la organización proveedora propietaria de la API y de los Productos asociados.
plan_id Serie El identificador del Plan.
ref_producto Serie La referencia del producto (nombre_producto:versión_producto)
nombre_espacio Serie El nombre del espacio para los productos que se publican en un espacio
Status_Code Serie El código de estado establecido en la respuesta saliente.
summary_event_id Serie ID único asignado al acontecimiento
tiempo_para_servir_solicitud Número El tiempo transcurrido (en milisegundos) desde que la pasarela recibió la solicitud hasta que envió una respuesta

Ejemplo de acta resumida

{
            "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
        }
Utilice las siguientes operaciones para recuperar datos de eventos de resumen de análisis con la API REST de API Connect Analytics:
Tabla 2. Operaciones para recuperar datos analíticos resumidos de eventos
Operación Descripción
GET /resumen Esta operación devuelve una lista de registros de eventos resumidos.
GET /resumen/:id Esta operación devuelve un registro resumido de eventos específico por su ID único.
GET /resumen/conteo Esta operación devuelve el número total de registros de eventos resumidos.
Nota: Estas operaciones también están presentes en la CLI de Analytics en Toolkit.