NetNut Dashboard

Usage

Get data usage

post

Usage

Authorizations
AuthorizationstringRequired
Body
dateRangestringOptional

Date range to search for package

Example: 2022-10-01,2022-11-01
planStatusnumberOptional

The plan status (1- active plans, 0- Inactive plans, 2- Standby plans, 3- All plans)

Example: 1
packageTypenumberOptional

Package type (1 - dc, 2 - isp , 3 - res )

Example: 1
bySubUserbooleanOptional

Show the list with sub-users (For reseller only)

Example: true
subUsersstringOptional

Filter by specific sub-user (For reseller only)

Example: 12345678, 23456789
Responses
200

Success

application/json
post
/customer/usage/
POST /v1/customer/usage/ HTTP/1.1
Host: customers-api.netnut.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "dateRange": "2022-10-01,2022-11-01",
  "planStatus": 1,
  "packageType": 1,
  "bySubUser": true,
  "subUsers": "12345678, 23456789"
}
{
  "success": true,
  "token": "text"
}

My Package Usage

post

My Package Usage

Authorizations
AuthorizationstringRequired
Body
dateRangestringOptional

Date range to search for package

Example: 2022-10-01,2022-11-01
planStatusnumberOptional

The plan status (1- active plans, 0- Inactive plans, 2- Standby plans, 3- All plans)

Example: 1
Responses
200

Success

application/json
post
/customer/usage/myusage
POST /v1/customer/usage/myusage HTTP/1.1
Host: customers-api.netnut.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "dateRange": "2022-10-01,2022-11-01",
  "planStatus": 1
}
{
  "success": true,
  "data": [
    {
      "id": 12345,
      "start_date": "2022-07-12T00:00:00.000Z",
      "end_date": "2023-08-13T03:00:42.000Z",
      "is_active": true,
      "total_requests_used": 765,
      "total_gb_used": 5,
      "usage_percentage": "41.33",
      "plan_gb": 10,
      "product_type": "Data Center"
    }
  ]
}

Get's all Plans by customer id ordered by active_plan && start_date

get

Get's all Plans by customer id ordered by active_plan && start_date

Authorizations
AuthorizationstringRequired
Path parameters
idanyRequired
Responses
200

Array of Plans

application/json
get
/customer/usage/{id}
GET /v1/customer/usage/{id} HTTP/1.1
Host: customers-api.netnut.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": [
    ""
  ]
}
PreviousTrafficsNextSub users

Last updated