LitmusEdgeManager 2.31.x API Documentation/Admin Console APIs/Dashboard - LE, LEM, LUNS API Docs

Basic Dashboard Stats

GET {{LEM_adminURL}}/admin/v1/dashboard/basic

Basic Dashboard Stats

Returns instance-wide totals: companies, projects, devices, cumulative messages, cumulative bytes. Backs the LEM admin console's landing page.

Endpoint

GET {{LEM_adminURL}}/admin/v1/dashboard/basic

Authentication

HTTP Basic Auth. Username is your API token, password is empty. Tokens are managed under System > Access Control > Tokens.

Response

{
  "companiesTotal": 7,
  "projectsTotal": 8,
  "devicesTotal": 11,
  "messagesTotal": 0,
  "bytesTotal": 35536508
}

Errors

HTTP status When it happens
400 Bad Request Missing or malformed query/body parameter.
401 Unauthorized Missing or invalid credentials.
403 Forbidden Token lacks permission for this operation.
404 Not Found Target entity does not exist.
5xx Service is unreachable, restarting, or internally errored. Inspect device logs under System > Support.

TLS note: edge devices use a self-signed certificate by default. Either install the device CA in your client trust store or disable certificate verification when calling this endpoint directly.

Response

Status: 200 OK

{
    "companiesTotal": 7,
    "projectsTotal": 8,
    "devicesTotal": 11,
    "messagesTotal": 0,
    "bytesTotal": 35536508
}

Project Stats

GET {{LEM_adminURL}}/admin/v1/dashboard/project-stats

Project Stats

Returns per-project usage stats across every company. Each row carries device count, message/byte totals, and Kafka consumer offsets/lags (loop-alerts-data, clickhouse-sink).

Endpoint

GET {{LEM_adminURL}}/admin/v1/dashboard/project-stats

Authentication

HTTP Basic Auth. Username is your API token, password is empty. Tokens are managed under System > Access Control > Tokens.

Errors

HTTP status When it happens
400 Bad Request Missing or malformed query/body parameter.
401 Unauthorized Missing or invalid credentials.
403 Forbidden Token lacks permission for this operation.
404 Not Found Target entity does not exist.
5xx Service is unreachable, restarting, or internally errored. Inspect device logs under System > Support.

TLS note: edge devices use a self-signed certificate by default. Either install the device CA in your client trust store or disable certificate verification when calling this endpoint directly.

Response

Status: 200 OK

[
    {
        "projectId": "39abjcmqdc6r4gsctj7zjufnv",
        "companyName": "solutions",
        "realCompanyName": "solutions",
        "projectName": "parth",
        "devicesTotal": 1,
        "messagesTotal": 0,
        "bytesTotal": 0,
        "consumerStats": [
            {
                "consumerName": "loop-alerts-data",
                "offset": 1,
                "lag": 0
            },
            {
                "consumerName": "clickhouse-sink",
                "offset": 1,
                "lag": 0
            }
        ]
    }
]

Get Notifications

GET {{LEM_adminURL}}/admin/v1/system/notifications

Get Notifications

Returns instance-level system notifications (license/device-limit warnings, disk-space alerts). Same shape as the ELM-side Dashboard > Get Notifications, but admin-scoped.

Endpoint

GET {{LEM_adminURL}}/admin/v1/system/notifications

Authentication

HTTP Basic Auth. Username is your API token, password is empty. Tokens are managed under System > Access Control > Tokens.

Errors

HTTP status When it happens
400 Bad Request Missing or malformed query/body parameter.
401 Unauthorized Missing or invalid credentials.
403 Forbidden Token lacks permission for this operation.
404 Not Found Target entity does not exist.
5xx Service is unreachable, restarting, or internally errored. Inspect device logs under System > Support.

TLS note: edge devices use a self-signed certificate by default. Either install the device CA in your client trust store or disable certificate verification when calling this endpoint directly.

Response

Status: 200 OK

[
    {
        "type": "license-device-limits",
        "status": "S",
        "message": null,
        "messageDetails": null,
        "maxDeviceCount": 0,
        "currentDeviceCount": 1
    },
    {
        "type": "disk-space",
        "status": "S",
        "message": null,
        "messageDetails": null,
        "dir": "/opt/lem",
        "totalSpace": 32196526080,
        "freeSpace": 22678786048
    },
    {
        "type": "disk-space",
        "status": "S",
        "message": null,
        "messageDetails": null,
        "dir": "/var/lib/lem",
        "totalSpace": 83710967808,
        "freeSpace": 74385469440
    },
    {
        "type": "incoming-data-paused",
        "status": "S",
        "message": null,
        "messageDetails": null
    }
]

View this page as Markdown