Read NMS status series

GET

/nmsstatus

Last modified:2026-10-07 23:39:09

OperationId:ReadNmsStatusSeries

Returns one core server's status counters over a time window, grouped into time buckets for graphing. Requires Super User or Super User Read Only scope.

The response has one shared timestamps array, and for each metric a values array aligned to it, plus summary figures: current, first, min, max, avg, change-percent, samples, and, for a counter, total.

hostname is required. Each core server keeps only its own status rows, so name the server to read. Use a hostname from GET /nmsstatus/servers. A request for another core server is passed to that server, and you get its answer.

Gauges and counters. A gauge, such as active sessions or a queue depth, is averaged per bucket unless you set gauge-aggregate, and its current is the latest raw sample. A counter, such as packets or SIP responses, only increases, so it is reported as a rate per second between consecutive buckets. A counter reset, such as a process restart, shows as null for that bucket, never as a negative rate. GET /nmsstatus/metrics says which metric is which.

Window and buckets. Use range for a window ending now, or datetime-start and datetime-end together for a fixed window. The explicit pair wins over range. Buckets are 1m, 10m, or 1h; raw samples are never returned. Without interval, the bucket follows the range: 1m up to 24h, 10m for 2d and 7d, and 1h for 28d. A series is limited to 2,000 buckets by default. An interval that would exceed it returns 400, naming a coarser interval to use. A bucket with no samples is null, not 0.

Times in the response use the offset of the datetime-start and datetime-end you send, or +00:00. Check start-datetime and end-datetime in the response: today a pair that cannot be read, or whose start is not before its end, is not always refused and can be replaced by a default window of about 61 days.

A series that ends now is cached for up to 60 seconds.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200OK

application/json

The series for the requested window and metrics.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🔴502Bad Gateway

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/nmsstatus?hostname=core1.example.com&range=24h&datetime-start=2026-09-01T14%3A20%3A00+00%3A00&datetime-end=2026-09-01T14%3A30%3A00+00%3A00&interval=1m&metrics=session-connected%2Ccnt-inv-rcv&gauge-aggregate=avg' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Two metrics, 10 minutes

hostname=core1.example.com&datetime-start=2026-09-01T14:20:00+00:00&datetime-end=2026-09-01T14:30:00+00:00&metrics=session-connected,cnt-inv-rcv

{
    "hostname": "core1.example.com",
    "range": null,
    "interval": "1m",
    "interval-seconds": 60,
    "gauge-aggregate": "avg",
    "start-datetime": "2026-09-01T14:20:00+00:00",
    "end-datetime": "2026-09-01T14:30:00+00:00",
    "timestamps": [
        1788272400,
        1788272460,
        1788272520,
        1788272580,
        1788272640,
        1788272700,
        1788272760,
        1788272820,
        1788272880,
        1788272940,
        1788273000
    ],
    "metrics": {
        "session-connected": {
            "type": "gauge",
            "unit": "sessions",
            "label": "Sessions connected (active calls)",
            "group": "sessions",
            "current": 54,
            "first": 42,
            "min": 42,
            "max": 53,
            "avg": 47.909,
            "change-percent": 28.57,
            "samples": 11,
            "values": [
                42,
                44,
                45,
                47,
                46,
                48,
                50,
                49,
                51,
                52,
                53
            ]
        },
        "cnt-inv-rcv": {
            "type": "counter",
            "unit": "requests/s",
            "label": "INVITE received",
            "group": "sip-responses",
            "current": 1.417,
            "first": 1.25,
            "min": 1.183,
            "max": 1.6,
            "avg": 1.373,
            "change-percent": 13.36,
            "samples": 11,
            "total": 906,
            "values": [
                1.25,
                1.4,
                1.183,
                1.317,
                1.5,
                1.367,
                1.6,
                1.45,
                1.283,
                1.333,
                1.417
            ]
        }
    }
}

Modified at 2026-10-07 23:39:09

List domain call park summaries

List NMS status metrics