Get WebSocket application metrics

Get metrics for a specific WebSocket application.

GET /websocket-applications/{websocketApplication}/metrics

Get WebSocket application metrics

cURL

curl --request GET \
  --url https://cloud.laravel.com/api/websocket-applications/{websocketApplication}/metrics \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://cloud.laravel.com/api/websocket-applications/{websocketApplication}/metrics"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://cloud.laravel.com/api/websocket-applications/{websocketApplication}/metrics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cloud.laravel.com/api/websocket-applications/{websocketApplication}/metrics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://cloud.laravel.com/api/websocket-applications/{websocketApplication}/metrics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://cloud.laravel.com/api/websocket-applications/{websocketApplication}/metrics")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://cloud.laravel.com/api/websocket-applications/{websocketApplication}/metrics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "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>"
    ]
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "errors": {}
}

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> | null

Available options: 6h, 24h, 3d, 7d, 30d

Response

200

application/json

data · object · required

Show child attributes

meta · object · required

Show child attributes