messaging

Get message statistics

Get messaging statistics including total messages, success rates, and breakdown by type (push, email, SMS). Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key).

GET/api/messaging/projects/{projectId}/messaging/stats

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) for the messaging project.

Query Parameters

Name	Type	Required	Description
`startDate`	string	No	Start of the date range for statistics (ISO 8601).
`endDate`	string	No	End of the date range for statistics (ISO 8601).

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.messaging.getStats({
  projectId: "proj_kBpDJflPLlrS"
});
const result = await client.messaging.getStats({
  projectId: "proj_kBpDJflPLlrS"
});

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.

Path Parameters

projectId

Query Parameters

startDate

endDate

No Request Yet

Send a request to see the full inspector

Responses

200Message statistics

json

{
  "stats": {
    "total": 1000,
    "sent": 950,
    "failed": 50,
    "byType": {
      "email": 600,
      "sms": 300,
      "push": 100
    }
  },
  "period": "month"
}
{
  "stats": {
    "total": 1000,
    "sent": 950,
    "failed": 50,
    "byType": {
      "email": 600,
      "sms": 300,
      "push": 100
    }
  },
  "period": "month"
}

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