Monitoring
Get performance metrics
Response time stats from AuditLog where available. With **projectId**, falls back to UsageStat latency averages when audit data is sparse (**latencySource** may be **usage_stat**).
GET
/api/monitoring/performanceSDK setup
Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.
import { Configuration, MonitoringApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
const monitoring = new MonitoringApi(configuration);import { Configuration, MonitoringApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
const monitoring = new MonitoringApi(configuration);Example request
Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.
const { data: result } = await monitoring.getMonitoringPerformance();const { data: result } = await monitoring.getMonitoringPerformance();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 →Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
projectId | string | No | — |
period | string | No | — |
Responses
200Performance metrics
json
{
"period": "matrix program",
"metrics": {
"totalRequests": 182,
"avgResponseTime": 659.54,
"minResponseTime": 845.22,
"maxResponseTime": 818.57,
"errorCount": 136,
"successCount": 137,
"successRate": 411.49,
"errorRate": 313.05,
"latencySource": "driver index"
},
"topEndpoints": [
{}
]
}{
"period": "matrix program",
"metrics": {
"totalRequests": 182,
"avgResponseTime": 659.54,
"minResponseTime": 845.22,
"maxResponseTime": 818.57,
"errorCount": 136,
"successCount": 137,
"successRate": 411.49,
"errorRate": 313.05,
"latencySource": "driver index"
},
"topEndpoints": [
{}
]
}401—
404Project not found
Errors
| Code | Meaning |
|---|---|
401 | — |
404 | Project not found |