🔗 Console REST APIConnection Analytics

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

Returns connection analytics for your organization grouped by service, protocol, and data center. Shows total connections, active connections, unique API keys, connection duration metrics, and activity timestamps.

GET
/api/connection-analytics/summary
Authorization<token>

API Key is required to access the endpoints

In: header

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

timeEnd?string

End time for the analysis period

minutes?integer

Minutes back from now (alternative to timeStart/timeEnd)

Response Body

curl -X GET "https://example.com/api/connection-analytics/summary"
[
  {
    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "serviceName": "coinapi-ws",
    "protocolName": "WebSocket",
    "dataCenter": "us-east-1/server-01",
    "totalConnections": 284,
    "newConnectionsInPeriod": 34,
    "averageConnectionDurationSeconds": 2134,
    "totalConnectionTimeSeconds": 10134,
    "firstConnection": "2024-01-14T08:15:30.0000000Z",
    "lastConnection": "2024-01-15T14:22:45.0000000Z",
    "lastActivity": "2024-01-15T14:30:25.0000000Z"
  },
  {
    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "serviceName": "coinapi-rest",
    "protocolName": "REST",
    "dataCenter": "eu-west-1/server-02",
    "totalConnections": 145,
    "newConnectionsInPeriod": 89,
    "averageConnectionDurationSeconds": 1847,
    "totalConnectionTimeSeconds": 4482,
    "firstConnection": "2024-01-14T09:30:15.0000000Z",
    "lastConnection": "2024-01-15T14:18:20.0000000Z",
    "lastActivity": "2024-01-15T14:28:10.0000000Z"
  }
]
Empty
Empty
Service StatusGitHub SDK