usage

Get usage trends

Get usage trends over time for the authenticated organization or project. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key).

GET/api/usage/trends

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
`days`	integer	No	Number of days of trend data to return (default 30).

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.getTrends();
const result = await client.usage.getTrends();

Try It Live

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

JWT Bearer Token Use the auth endpoints to obtain a JWT.

Query Parameters

days

No Request Yet

Send a request to see the full inspector

Responses

200Usage trends

json

{
  "trends": [
    {
      "date": "2024-01-01",
      "apiCalls": 1000,
      "storage": 104857600
    },
    {
      "date": "2024-01-02",
      "apiCalls": 1200,
      "storage": 104857600
    }
  ],
  "days": 30
}
{
  "trends": [
    {
      "date": "2024-01-01",
      "apiCalls": 1000,
      "storage": 104857600
    },
    {
      "date": "2024-01-02",
      "apiCalls": 1200,
      "storage": 104857600
    }
  ],
  "days": 30
}

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.

Run in Postman Download OpenAPI

Next steps

Edit this page on GitHub