🔗 Console REST APIConnection Analytics

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

Returns connection analytics for your organization aggregated by time intervals. Shows connection counts, active connections, unique API keys, and connection duration metrics over time.

GET
/api/connection-analytics/time-series

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

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

Time-series connection analytics retrieved successfully

  1. response
[index: integer]?
curl -X GET 'https://api-console.apibricks.io/api/connection-analytics/time-series'
[  {    "timeSlot": "2024-01-15T14:00:00.0000000Z",    "totalConnectionsInPeriod": 125,    "newConnectionsInPeriod": 12,    "connectionCountOnPeriodEnd": 98,    "connectionCountOnPeriodStart": 113,    "uniqueOrganizations": 1,    "averageConnectionDurationSeconds": 1847,    "totalConnectionTimeSeconds": 230760  },  {    "timeSlot": "2024-01-15T13:00:00.0000000Z",    "totalConnectionsInPeriod": 118,    "newConnectionsInPeriod": 9,    "connectionCountOnPeriodEnd": 92,    "connectionCountOnPeriodStart": 109,    "uniqueOrganizations": 1,    "averageConnectionDurationSeconds": 1923,    "totalConnectionTimeSeconds": 227160  }]