🔗 Console REST APIConnection Analytics

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

Returns connection event analytics for your organization aggregated by time intervals and event types. Use for trend analysis, monitoring dashboards, and event pattern recognition.

GET
/api/connection-analytics/events/timeseries

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
intervalMinutes?integer

Time interval in minutes for grouping (5, 15, 30, 60, 360, 720, 1440)

Formatint32
Default60
limit?integer

Maximum number of records to return

Formatint32
Default1000

Response Body

Connection event time series retrieved successfully

  1. response
[index: integer]?
curl -X GET 'https://api-console.apibricks.io/api/connection-analytics/events/timeseries'
[  {    "timeSlot": "2024-01-01T11:00:00.0000000Z",    "eventType": "connect",    "eventCount": 12,    "uniqueConnections": 11,    "uniqueOrganizations": 1  },  {    "timeSlot": "2024-01-01T11:00:00.0000000Z",    "eventType": "heartbeat",    "eventCount": 156,    "uniqueConnections": 11,    "uniqueOrganizations": 1  },  {    "timeSlot": "2024-01-01T11:00:00.0000000Z",    "eventType": "disconnect",    "eventCount": 9,    "uniqueConnections": 9,    "uniqueOrganizations": 1  }]

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

Previous Page

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

Next Page