Projects
Get project usage statistics
GET
/api/projects/{orgId}/projects/{id}/usageSDK 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',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
const projects = new ProjectsApi(configuration);import { Configuration, ProjectsApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
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.getProjectUsage("org_faaPu3QfA5", "WHOtZ7A1HTOnqKoE");const { data: result } = await projects.getProjectUsage("org_faaPu3QfA5", "WHOtZ7A1HTOnqKoE");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 →Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
orgId | string | Yes | Organization ID |
id | string | Yes | Project ID |
Responses
200Project usage statistics
json
{
"usage": {
"apiCalls": 15000,
"storage": 52428800,
"bandwidth": 1073741824,
"databaseReads": 5000,
"databaseWrites": 2000
},
"limits": {
"apiCalls": 100000,
"storage": 1073741824,
"bandwidth": 10737418240,
"databaseReads": 50000,
"databaseWrites": 10000
}
}{
"usage": {
"apiCalls": 15000,
"storage": 52428800,
"bandwidth": 1073741824,
"databaseReads": 5000,
"databaseWrites": 2000
},
"limits": {
"apiCalls": 100000,
"storage": 1073741824,
"bandwidth": 10737418240,
"databaseReads": 50000,
"databaseWrites": 10000
}
}