Projects

Project dashboard overview

Single response for the project overview UI: project info, request counts and day-over-day % change, active users (distinct JWT users with project activity; realtime socket count when available), **Uptime** (30d headline) is organization-wide when enough HTTP samples exist, else DB heartbeat probes. **Average latency** (today / 7d) is **per project** and counts only routes documented in `openapi-docs.yaml` for customer/project API (excludes auth, `/api/users`, `/api/orgs`, role-elevation, and multi-role admin routes). Request volume and active users remain per-project. 14-day API call volume and recent audit activity are per-project. See docs/dashboard-overview-api.md.

AuthJWT or API Key
GroupProjects
Rate limitSee Rate Limits
GET/api/projects/{projectId}/dashboard/overview

SDK setup

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

import { Configuration, ProjectsApi } from 'mudbase-sdk';

const configuration = new Configuration({
  basePath: 'https://cloud.mudbase.dev',
  apiKey: 'sk_live_mudbase_doc_Xk9mP2qR7vN4wL8jH3tY6uE',
  accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
// This endpoint accepts either credential — apiKey or accessToken alone is enough.

const projects = new ProjectsApi(configuration);
import { Configuration, ProjectsApi } from 'mudbase-sdk';

const configuration = new Configuration({
  basePath: 'https://cloud.mudbase.dev',
  apiKey: 'sk_live_mudbase_doc_Xk9mP2qR7vN4wL8jH3tY6uE',
  accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
// This endpoint accepts either credential — apiKey or accessToken alone is enough.

const projects = new ProjectsApi(configuration);

Example request

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

const { data: result } = await projects.getProjectDashboardOverview("proj_4YQ3W38NK4f7");
const { data: result } = await projects.getProjectDashboardOverview("proj_4YQ3W38NK4f7");

Playground

live

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

Get your API key from the console
Use the auth endpoints to obtain a JWT.

No Request Yet

Send a request to see the full inspector

Authentication

Requires JWT Requires API Key JWT or API Key
Note
This endpoint accepts either JWT Bearer token or API Key. Use Authorization: Bearer YOUR_TOKEN for user context, or X-API-Key: YOUR_KEY for server-to-server. View authentication guide →Include your JWT in the Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →Include your API key in the X-API-Key: YOUR_KEY header (server-to-server, SDKs). View authentication guide →

Path Parameters

NameTypeRequiredDescription
projectIdstringYes—

Responses

200Dashboard overview
json
{
  "success": true,
  "data": {
    "project": {
      "id": "bHmFlGxJr84Jja0P",
      "name": "Candice Becker",
      "slug": "graceful-squid-ciir"
    },
    "requests": {
      "today": 26,
      "yesterday": 5,
      "latencyTrackedToday": 19,
      "latencyTrackedYesterday": 28,
      "meteringNote": "array override",
      "changePct": 890.14,
      "direction": "down"
    },
    "activeUsers": {
      "last24h": 67834,
      "last7d": 35770,
      "last30d": 89671,
      "changePct7d": 95.84,
      "direction7d": "panel hack",
      "realtimeConnected": 89196
    },
    "latency": {
      "scope": "project_openapi_doc",
      "avgMsToday": 11,
      "avgMs7d": 15993,
      "latencySamplesToday": 2,
      "latencyNeedsTraffic": true,
      "interpretation": "system program",
      "instanceRollup": {
        "scope": "instance_recent",
        "p50Ms": 89382,
        "p95Ms": 51728,
        "p99Ms": 89542,
        "meanMs": 9425,
        "samplesApprox": 7621,
        "templatesTracked": 82259
      },
      "topRoutesByImpactHint": [
        {
          "routeKey": "unwritten-nightlife-afqh",
          "p50Ms": 23211,
          "p95Ms": 61387,
          "count": 95,
          "impactScore": 68825
        }
      ]
    },
    "uptime": {
      "scope": "organization",
      "displayPct30d": 268.11,
      "displaySource": "system back up",
      "isPreliminary": true,
      "platformProbePct30d": 930.65,
      "platformSamples": 86595,
      "platformOkSamples": 42923,
      "orgHttpNon5xxPct30d": 561.72,
      "orgHttpSampled30d": 79997,
      "orgHttp5xx30d": 93436,
      "projectHttp5xx30d": 51666,
      "globalHttpNon5xxPct30d": 633.08,
      "globalHttpSampled30d": 14045,
      "requestNon5xxPct30d": 628.56,
      "requestSampled30d": 23161,
      "projectHttpNon5xxPct30d": 341.3,
      "projectHttpSampled30d": 38553,
      "help": "array navigate"
    },
    "requestVolume14d": [
      {
        "date": "2025-03-18",
        "apiCalls": 38726,
        "latencyTracked": 88728
      }
    ],
    "recentActivity": [
      {
        "id": "SkyE6hHlCJBJ1Pon",
        "at": "2026-07-01T08:47:41.269Z",
        "action": "microchip navigate",
        "title": "Immersive bifurcated model",
        "detail": "array navigate",
        "actorEmail": "dana_fadel-daugherty57@northwind.dev"
      }
    ],
    "generatedAt": "2026-06-23T13:49:47.416Z"
  }
}
{
  "success": true,
  "data": {
    "project": {
      "id": "bHmFlGxJr84Jja0P",
      "name": "Candice Becker",
      "slug": "graceful-squid-ciir"
    },
    "requests": {
      "today": 26,
      "yesterday": 5,
      "latencyTrackedToday": 19,
      "latencyTrackedYesterday": 28,
      "meteringNote": "array override",
      "changePct": 890.14,
      "direction": "down"
    },
    "activeUsers": {
      "last24h": 67834,
      "last7d": 35770,
      "last30d": 89671,
      "changePct7d": 95.84,
      "direction7d": "panel hack",
      "realtimeConnected": 89196
    },
    "latency": {
      "scope": "project_openapi_doc",
      "avgMsToday": 11,
      "avgMs7d": 15993,
      "latencySamplesToday": 2,
      "latencyNeedsTraffic": true,
      "interpretation": "system program",
      "instanceRollup": {
        "scope": "instance_recent",
        "p50Ms": 89382,
        "p95Ms": 51728,
        "p99Ms": 89542,
        "meanMs": 9425,
        "samplesApprox": 7621,
        "templatesTracked": 82259
      },
      "topRoutesByImpactHint": [
        {
          "routeKey": "unwritten-nightlife-afqh",
          "p50Ms": 23211,
          "p95Ms": 61387,
          "count": 95,
          "impactScore": 68825
        }
      ]
    },
    "uptime": {
      "scope": "organization",
      "displayPct30d": 268.11,
      "displaySource": "system back up",
      "isPreliminary": true,
      "platformProbePct30d": 930.65,
      "platformSamples": 86595,
      "platformOkSamples": 42923,
      "orgHttpNon5xxPct30d": 561.72,
      "orgHttpSampled30d": 79997,
      "orgHttp5xx30d": 93436,
      "projectHttp5xx30d": 51666,
      "globalHttpNon5xxPct30d": 633.08,
      "globalHttpSampled30d": 14045,
      "requestNon5xxPct30d": 628.56,
      "requestSampled30d": 23161,
      "projectHttpNon5xxPct30d": 341.3,
      "projectHttpSampled30d": 38553,
      "help": "array navigate"
    },
    "requestVolume14d": [
      {
        "date": "2025-03-18",
        "apiCalls": 38726,
        "latencyTracked": 88728
      }
    ],
    "recentActivity": [
      {
        "id": "SkyE6hHlCJBJ1Pon",
        "at": "2026-07-01T08:47:41.269Z",
        "action": "microchip navigate",
        "title": "Immersive bifurcated model",
        "detail": "array navigate",
        "actorEmail": "dana_fadel-daugherty57@northwind.dev"
      }
    ],
    "generatedAt": "2026-06-23T13:49:47.416Z"
  }
}
401—
404—

Errors

CodeMeaning
401—
404—
Run in PostmanDownload OpenAPI

Next

NEXT →API Reference OverviewBase URL, rate limits, pagination, and the full endpoint index.NEXT →AuthenticationAPI keys, Bearer tokens, and user sessions.NEXT →API PlaygroundSearch any endpoint and send a live request.
Edit this page on GitHub