Main DocsDashboard

Global Statistics API

Intro

The Global Statistics API provides network-wide usage metrics across Karrier One’s public infrastructure, including gateways, WiFi nodes, and client sessions. These endpoints allow you to retrieve live and historical data usage trends, unique client counts, and session statistics.

How It Works

All endpoints return 200 OK responses with usage data in JSON format. The statistics are grouped by:

  • Global Public Stats: High-level aggregate of total users, GBs, and sessions.

  • Gateway Stats: Time-based usage from public gateways.

  • WiFi Stats: Time-based usage from WiFi infrastructure.

  • WiFi Nodes: Detailed node-level information.

  • KNS Stats: Karrier Number System Users and time-based signups per country

Some endpoints require a date range in ISO 8601 format for historical analysis.

Global public statistics

get

Global public statistics

Responses
200Success
application/json
get
/api/v1/UsageGraph/global-public-stats
GET /api/v1/UsageGraph/global-public-stats HTTP/1.1
Host: n-api.karrier.one
Accept: */*
200Success
{
  "totalUniqueClients": 1,
  "totalGB": 1,
  "totalSessions": 1
}

Global public gateway stats

post

Global public gateway stats

Body
startstring · date-timeRequired
endstring · date-timeRequired
Responses
200Success
application/json
post
/api/v1/UsageGraph/global-public-gateway-stats
POST /api/v1/UsageGraph/global-public-gateway-stats HTTP/1.1
Host: n-api.karrier.one
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "start": "2025-11-09T19:27:15.865Z",
  "end": "2025-11-09T19:27:15.865Z"
}
200Success
{
  "totalCumulativeUniqueClients": 1,
  "totalCumulativeGB": 1,
  "totalCumulativeSessions": 1,
  "periodUsage": {
    "currentUsageMB": 1,
    "currentClients": 1,
    "currentSessions": 1,
    "dataUsageMB": [
      [
        1
      ]
    ],
    "clients": [
      [
        1
      ]
    ],
    "sessions": [
      [
        1
      ]
    ],
    "gatewayNodes": [
      {
        "location": "text",
        "uid": "text",
        "lat": 1,
        "lon": 1,
        "status": "Pending",
        "spectrum": "text"
      }
    ]
  }
}

Global public wifi stats

post

Global public wifi stats

Body
startstring · date-timeRequired
endstring · date-timeRequired
Responses
200Success
application/json
post
/api/v1/UsageGraph/global-public-wifi-stats
POST /api/v1/UsageGraph/global-public-wifi-stats HTTP/1.1
Host: n-api.karrier.one
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "start": "2025-11-09T19:27:15.865Z",
  "end": "2025-11-09T19:27:15.865Z"
}
200Success
{
  "totalCumulativeUniqueClients": 1,
  "totalCumulativeGB": 1,
  "totalCumulativeSessions": 1,
  "periodUsage": {
    "currentUsageMB": 1,
    "currentClients": 1,
    "currentSessions": 1,
    "dataUsageMB": [
      [
        1
      ]
    ],
    "clients": [
      [
        1
      ]
    ],
    "sessions": [
      [
        1
      ]
    ],
    "gatewayNodes": [
      {
        "location": "text",
        "uid": "text",
        "lat": 1,
        "lon": 1,
        "status": "Pending",
        "spectrum": "text"
      }
    ]
  }
}
post
Responses
200Success
application/json
post
/api/v1/Wifi/wifi-nodes
POST /api/v1/Wifi/wifi-nodes HTTP/1.1
Host: n-api.karrier.one
Accept: */*
200Success
[
  {
    "name": "text",
    "uid": "text",
    "lat": 1,
    "lon": 1,
    "status": "text",
    "model": "text",
    "wifi_level": "text"
  }
]

Global public kns stats

post

Global public kns stats

Body
startstring · date-timeRequired
endstring · date-timeRequired
Responses
200Success
application/json
post
/api/v1/UsageGraph/global-public-kns-stats
POST /api/v1/UsageGraph/global-public-kns-stats HTTP/1.1
Host: n-api.karrier.one
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "start": "2025-11-09T19:27:15.865Z",
  "end": "2025-11-09T19:27:15.865Z"
}
200Success
{
  "totalKNS": 1,
  "totalPerCountry": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "periodUsage": {
    "kns": 1,
    "ts": [
      1
    ],
    "perCountry": {
      "ANY_ADDITIONAL_PROPERTY": [
        1
      ]
    }
  }
}

Conclusion

The Global Statistics API is what you need to embed Karrier One's global analytics into your project.

If you have questions or need assistance, please reach out to [email protected].

🔗 Reference

16KB
n-api-swagger-public.json
Open
Karrier One Global Statistics OpenAPI
PreviousCall Verification Flow

Last updated