Skip to main content
GET
/
websocket-applications
/
{websocketApplication}
/
metrics
Get WebSocket application metrics
curl --request GET \
  --url https://cloud.laravel.com/api/websocket-applications/{websocketApplication}/metrics \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "connection_count": {
      "labels": [
        "<string>"
      ],
      "average": [
        123
      ],
      "data": [
        {
          "x": "<string>",
          "y": [
            123
          ]
        }
      ]
    },
    "message_rate": {
      "labels": [
        "<string>"
      ],
      "average": [
        123
      ],
      "data": [
        {
          "x": "<string>",
          "y": [
            123
          ]
        }
      ]
    }
  },
  "meta": {
    "period": "<string>",
    "available_periods": [
      "<string>"
    ]
  }
}

Authorizations

Authorization
string
header
required

The Bearer Token generated on the Cloud UI.

Path Parameters

websocketApplication
string
required

The websocket application identifier

Query Parameters

period
enum<string>
Available options:
6h,
24h,
3d,
7d,
30d

Response

data
object
required
meta
object
required