🔗 Console REST APIConnection Analytics

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

Returns connection event analytics for your organization grouped by service, protocol, data center, and event type. Use for understanding your organization's connection patterns and troubleshooting.

GET
/api/connection-analytics/events/organization-summary

Authorization

headerAuthorization<token>

API Key is required to access the endpoints

Query Parameters

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 analysis period

Formatdate-time
timeEnd?string

End time for the analysis period

Formatdate-time
minutes?integer

Minutes back from now (alternative to timeStart/timeEnd)

Formatint32

Response Body

Organization connection event summary retrieved successfully

  1. response
[index: integer]?
curl -X GET 'https://api-console.apibricks.io/api/connection-analytics/events/organization-summary'
[  {    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",    "serviceName": "coinapi-ws",    "protocolName": "WebSocket",    "dataCenter": "us-east-1",    "eventType": "connect",    "eventCount": 245,    "uniqueConnections": 189,    "firstEvent": "2023-12-25T12:00:00.0000000Z",    "lastEvent": "2024-01-01T11:45:00.0000000Z"  },  {    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",    "serviceName": "coinapi-ws",    "protocolName": "WebSocket",    "dataCenter": "us-east-1",    "eventType": "heartbeat",    "eventCount": 3456,    "uniqueConnections": 189,    "firstEvent": "2023-12-25T12:00:00.0000000Z",    "lastEvent": "2024-01-01T11:59:00.0000000Z"  },  {    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",    "serviceName": "coinapi-rest",    "protocolName": "HTTP",    "dataCenter": "us-east-1",    "eventType": "connect",    "eventCount": 1890,    "uniqueConnections": 1890,    "firstEvent": "2023-12-25T12:00:00.0000000Z",    "lastEvent": "2024-01-01T11:57:00.0000000Z"  }]