🔗 Console REST APIConnection Analytics

Gets raw connection event records with flexible filtering for the current organization

Returns raw connection event entries for your organization with flexible filtering options. Use for detailed event analysis, troubleshooting, and historical tracking. Includes all event types and descriptions.

GET
/api/connection-analytics/events/query

Authorization

headerAuthorization<token>

API Key is required to access the endpoints

Query Parameters

connectionId?string

Optional connection ID filter

serviceName?string

Optional service name filter

protocolName?string

Optional protocol name filter

dataCenter?string

Optional data center filter

eventType?string

Optional event type filter

timeStart?string

Start time for the query range (EventTimestamp)

Formatdate-time
timeEnd?string

End time for the query range (EventTimestamp)

Formatdate-time
minutes?integer

Minutes back from now (alternative to timeStart/timeEnd)

Formatint32
limit?integer

Maximum number of records to return

Formatint32
Default1000

Response Body

Connection events retrieved successfully

  1. response
[index: integer]?
curl -X GET 'https://api-console.apibricks.io/api/connection-analytics/events/query'
[  {    "eventId": "12345678-1234-5678-9abc-123456789012",    "connectionId": "conn_7f9a8b2c1d3e4f5a",    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",    "host": "ws-server-01.coinapi.io",    "ipAddress": "203.0.113.195",    "protocolName": "WebSocket",    "serviceName": "coinapi-ws",    "dataCenter": "us-east-1",    "eventType": "connect",    "eventDescription": "WebSocket connection established",    "eventTimestamp": "2024-01-01T11:30:00.0000000Z"  },  {    "eventId": "87654321-4321-8765-cba9-876543210987",    "connectionId": "conn_7f9a8b2c1d3e4f5a",    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",    "host": "ws-server-01.coinapi.io",    "ipAddress": "203.0.113.195",    "protocolName": "WebSocket",    "serviceName": "coinapi-ws",    "dataCenter": "us-east-1",    "eventType": "heartbeat",    "eventDescription": "Connection heartbeat received",    "eventTimestamp": "2024-01-01T11:55:00.0000000Z"  },  {    "eventId": "abcdef12-3456-7890-abcd-ef1234567890",    "connectionId": "conn_7f9a8b2c1d3e4f5a",    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",    "host": "ws-server-01.coinapi.io",    "ipAddress": "203.0.113.195",    "protocolName": "WebSocket",    "serviceName": "coinapi-ws",    "dataCenter": "us-east-1",    "eventType": "disconnect",    "eventDescription": "WebSocket connection closed by client",    "eventTimestamp": "2024-01-01T11:58:00.0000000Z"  }]

Gets connection analytics grouped by service, protocol, and data center for the current organization GET

Previous Page

Gets time-series connection event analytics with flexible filtering for the current organization GET

Next Page