Sign in
Realtime

Get realtime statistics for a project

Changed on

Returns realtime usage statistics including connection counts and subscribed tables.

get/projects/{id}/realtime/stats

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/projects/{id}/realtime/stats
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring uuid required

Project ID

Response

Realtime statistics

num_connectionsinteger

Current number of active connections

peak_connectionsinteger

Peak concurrent connections this usage period

last_invoked_atstring date-time

Most recent realtime activity timestamp across channels

Example response

{
  "limits": {
    "plan": "HOBBY",
    "max_connections": 100,
    "messages_per_month": 1000000,
    "message_size_kb": 32,
    "channels_per_conn": 100
  }
}

Changes

  • 23e7875e7c4cRevision changes
    • ○

      the endpoint scheme security ProjectAccessToken was added to the API

  • 3a6f365f3f35Revision changes
    • ▲

      added the new path request parameter id

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the required property to the response with the status