🔗 Console REST APIConnection Analytics

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

Returns raw connection status records for your organization with flexible filtering options. Use for detailed analysis, UI display, and export. Includes connection duration, active status, and heartbeat information.

GET
/api/connection-analytics/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

activeOnly?boolean

Filter for active connections only (heartbeat within last 2 minutes)

timeStart?string

Start time for the query range (ConnectionStartTime)

Formatdate-time
timeEnd?string

End time for the query range (ConnectionStartTime)

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 status records retrieved successfully

  1. response
[index: integer]?
curl -X GET 'https://api-console.apibricks.io/api/connection-analytics/query'
[  {    "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/server-01",    "lastHeartbeat": "2024-01-15T14:30:25.0000000Z",    "connectionStartTime": "2024-01-15T14:15:10.0000000Z",    "updatedAt": "2024-01-15T14:30:25.0000000Z",    "connectionDurationSeconds": 915,    "isActive": true  },  {    "connectionId": "conn_8e7d6c5b4a321098",    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",    "host": "rest-api-01.coinapi.io",    "ipAddress": "203.0.113.196",    "protocolName": "REST",    "serviceName": "coinapi-rest",    "dataCenter": "eu-west-1/server-02",    "lastHeartbeat": "2024-01-15T13:45:30.0000000Z",    "connectionStartTime": "2024-01-15T13:30:15.0000000Z",    "updatedAt": "2024-01-15T13:45:30.0000000Z",    "connectionDurationSeconds": 915,    "isActive": false  }]

Gets the latest audit log events for the current organization (no time filtering) GET

Previous Page

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

Next Page