API Reference

GET Realtime

Retrieve the current active visitor count.

GET Realtime

GET https://api.faurya.com/api/v1/analytics/realtime

Retrieve active visitor count for the authenticated site. Requires Bearer Token authentication.

Query parameters

  • windowMs (number): Activity window in milliseconds. Defaults to 300000 (5 minutes).

Response

  • 200 OK: Returns active visitor count.
  • 401 Unauthorized: Missing or invalid API key.

Example request

const response = await fetch(
  "https://api.faurya.com/api/v1/analytics/realtime",
  {
    headers: {
      Authorization: `Bearer ${process.env.FAURYA_API_KEY}`,
    },
  },
);

const result = await response.json();

Success response

{
  "success": true,
  "data": [
    {
      "visitors": 12
    }
  ]
}