API Reference

GET Realtime Map

Retrieve active visitors and recent activity for the live map.

GET Realtime Map

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

Retrieve active visitors and recent activities for realtime map views. Requires Bearer Token authentication.

Query parameters

  • windowMs (number): Activity window in milliseconds. Defaults to 600000 (10 minutes).
  • limitVisitors (number): Maximum active visitors returned. Defaults to 200.
  • limitActivities (number): Maximum recent activities returned. Defaults to 500.
  • referrer (string): Filter active visitors by referrer.
  • deviceType (string): Filter active visitors by device type.
  • countryCode (string): Filter active visitors by country code.

Response

  • 200 OK: Returns active visitor count, visitors, and recent activities.
  • 401 Unauthorized: Missing or invalid API key.
  • 404 Not Found: Site not found.

Example request

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

const result = await response.json();

Success response

{
  "success": true,
  "data": [
    {
      "count": 2,
      "visitors": [],
      "recentActivities": []
    }
  ]
}