Get Bandwidth Usage

Retrieve monthly media bandwidth usage (downloaded, uploaded, and saved/blocked bytes) across all sessions or for a specific instance.

GET
https://api.wawp.net/v2/usage/bandwidth?access_token=YOUR_ACCESS_TOKEN&instance_id=123456789&month=2026-11

Authentication Required

Login to swap the placeholders with your real Instance ID and Access Token.

Log In
Test /v2/usage/bandwidth endpoint
GETPOST

No query parameters required

This endpoint doesn't expect data in the URL.

Best practices

  • Monitor summary.total_mb against summary.plan_bandwidth_limit_mb to avoid hitting monthly media caps.

  • Use /v2/session/media-settings to tune auto-download rules if video or status bandwidth is high.

Monthly Media Bandwidth Analytics

The /v2/usage/bandwidth endpoint provides a detailed breakdown of your account's media bandwidth consumption for any billing month (YYYY-MM), including incoming (rx), outgoing (tx), and saved (blocked) traffic across images, videos, audio, documents, and statuses.


📊 Key Metrics Returned

  • summary: Total MB used, plan bandwidth limit in MB, downloaded RX MB, uploaded TX MB, and bandwidth saved by media settings filters.
  • breakdown: Granular per-media-type MB and file counts (images, videos, audio, documents, statuses, profile_picture_requests).

Request Parameters

Configure the parameters required to interact with this endpoint. All query and body arguments are listed below with their details.

Query Parameters & Request Body

Supported in URL Query String or JSON Body
string—

Optional Instance ID to filter bandwidth usage for a single session. If omitted, returns account-wide totals.

Example:
string

Your API Access Token.

Example:
string—

Billing month in YYYY-MM format (defaults to current UTC month).

Example:

Build with AI using Wawp MCP

MCP READY

Connect Wawp API directly to Cursor, Windsurf, or Claude Desktop. Let AI write, test, and execute your WhatsApp integration code automatically!

How to Connect

Request Samples

Use these ready-to-go code snippets to integrate our API into your project quickly and efficiently. Choose your preferred language and library.

1const baseUrl = "https://api.wawp.net";
2const endpoint = "/v2/usage/bandwidth";
3const params = new URLSearchParams({
4 "instance_id": "123456789",
5 "access_token": "YOUR_ACCESS_TOKEN",
6 "month": "2026-11"
7}).toString();
8
9
10fetch(`${baseUrl}${endpoint}${params ? '?' + params : ''}`, {
11 method: "GET",
12 headers: { "Content-Type": "application/json" },
13
14})
15 .then(async (response) => {
16 if (response.ok) {
17 const data = await response.json();
18 console.log("Success:", data);
19 return data;
20 }
21
22 // Error Handling
23 if (response.status === 400) {
24 console.error("Error 400: Bad Request - Missing Required Parameter(s)");
25 }
26 if (response.status === 401) {
27 console.error("Error 401: Unauthorized - Invalid or Missing Access Token");
28 }
29 if (response.status === 500) {
30 console.error("Error 500: Internal Server Error - Unexpected Failure");
31 }
32
33 const errorText = await response.text();
34 console.error(`Error ${response.status}: ${errorText}`);
35 })
36 .catch((error) => console.error("Network Error:", error));
Interactive Samples
Ln 36, Col 1javascript

Expected Responses

Explore all possible responses and outcomes from the server. We have documented each status code with data examples to make success and error handling easier.

Bandwidth usage retrieved successfully
application/json
string *
string *
number *
string *
object *
object *

Example

{
"status": "success",
"billing_month": "2026-11",
"user_id": 1,
"instance_id": "all",
"summary": {
  "total_bytes": 52428800,
  "total_mb": 50,
  "plan_bandwidth_limit_mb": 2048,
  "downloaded_rx_bytes": 31457280,
  "downloaded_rx_mb": 30,
  "uploaded_tx_bytes": 20971520,
  "uploaded_tx_mb": 20,
  "saved_blocked_bytes": 104857600,
  "saved_blocked_mb": 100
  },
"breakdown": {
  "images": {
    "rx_mb": 15,
    "tx_mb": 10,
    "count": 120
    },
  "videos": {
    "rx_mb": 10,
    "tx_mb": 5,
    "count": 15
    },
  "audio": {
    "rx_mb": 3,
    "tx_mb": 2,
    "count": 40
    },
  "documents": {
    "rx_mb": 2,
    "tx_mb": 3,
    "count": 12
    },
  "statuses": {
    "rx_mb": 0,
    "count": 0
    },
  "profile_picture_requests": 25
  }
}
Bad Request - Missing Required Parameter(s)
Unauthorized - Invalid or Missing Access Token
Internal Server Error - Unexpected Failure
Previous TopicSession Media & Ignore Settings
Next TopicAbout login authentication

Command Palette

Search for a command to run...