usage
Get project usage
Get usage statistics for a project (API calls, storage, bandwidth, database operations). Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key).
GET
/api/usage/projects/{projectId}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 |
|---|---|---|---|
projectId | string | Yes | Project ID (MongoDB ObjectId) to get usage for. |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
period | string | No | Aggregation period for usage (day, week, or month). |
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.usage.getProject({
projectId: "proj_NsrYkqsp0xJ8"
});const result = await client.usage.getProject({
projectId: "proj_NsrYkqsp0xJ8"
});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 usage statistics
json
{
"usage": {
"apiCalls": 15000,
"storage": 52428800,
"bandwidth": 1073741824,
"databaseReads": 5000,
"databaseWrites": 2000
},
"period": "month",
"projectId": "685ad30be129932fbb7a1047"
}{
"usage": {
"apiCalls": 15000,
"storage": 52428800,
"bandwidth": 1073741824,
"databaseReads": 5000,
"databaseWrites": 2000
},
"period": "month",
"projectId": "685ad30be129932fbb7a1047"
}401Authentication required or invalid token.
403Access denied or insufficient permissions.
Errors
| Code | Meaning |
|---|---|
401 | Authentication required or invalid token. |
403 | Access denied or insufficient permissions. |