Real-time Analytics
Get global real-time analytics
Returns system-wide real-time metrics (admin only)
GET
/api/realtime/analyticsSDK setup
Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.
import { Configuration, RealTimeAnalyticsApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
const realtimeanalytics = new RealTimeAnalyticsApi(configuration);import { Configuration, RealTimeAnalyticsApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
const realtimeanalytics = new RealTimeAnalyticsApi(configuration);Example request
Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.
const { data: result } = await realtimeanalytics.getGlobalAnalytics();const { data: result } = await realtimeanalytics.getGlobalAnalytics();Playground
liveTest 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
Authentication
Requires JWT
Note
Include your JWT in the
Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →Responses
200Global analytics data
json
{
"activeConnections": 150,
"peakConnections": 200,
"totalEvents": 50000,
"eventsPerMinute": 120
}{
"activeConnections": 150,
"peakConnections": 200,
"totalEvents": 50000,
"eventsPerMinute": 120
}401—
403—
Errors
| Code | Meaning |
|---|---|
401 | — |
403 | — |