realtimeAnalytics

Get project real-time analytics

Returns real-time metrics for a specific project (active connections, events, etc.)

GET/api/realtime/projects/{projectId}/analytics

Authentication

Requires JWT
Note
Include your JWT in the Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →

Path Parameters

NameTypeRequiredDescription
projectIdstringYesProject ID (MongoDB ObjectId) to get real-time analytics for.

SDK setup

Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.

import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");
import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");

Example request

Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.

const result = await client.realtimeAnalytics.getProject({
  projectId: "proj_AGudIl5ciUid"
});
const result = await client.realtimeAnalytics.getProject({
  projectId: "proj_AGudIl5ciUid"
});

Try It Live

Test this endpoint with your own credentials. Your requests will be sent to the live API.

Use the auth endpoints to obtain a JWT.

No Request Yet

Send a request to see the full inspector

Responses

200Project analytics data
json
{
  "projectId": "685ad30be129932fbb7a1047",
  "activeConnections": 42,
  "totalEvents": 15234,
  "lastActivity": "2024-01-15T10:00:00.000Z",
  "timestamp": "2024-01-15T10:00:00.000Z"
}
{
  "projectId": "685ad30be129932fbb7a1047",
  "activeConnections": 42,
  "totalEvents": 15234,
  "lastActivity": "2024-01-15T10:00:00.000Z",
  "timestamp": "2024-01-15T10:00:00.000Z"
}
401Authentication required or invalid token.
404Project not found (exact backend message).

Errors

CodeMeaning
401Authentication required or invalid token.
404Project not found (exact backend message).

Next steps

Edit this page on GitHub