Traffic by edge node, across your domains

GET

/analytics/nodes-overview

curl --request GET \
  --url 'https://api.nsin.ir/analytics/nodes-overview?period=3h' \
  --header 'Authorization: Bearer <token>'

• Production

Per-node totals, error and cache rates, latency, a requests-over-time series, and the busiest domains on each node — aggregated over every domain you can see, or one domain with domain_id.

This is the account-wide counterpart of /analytics/traffic-by-node, which covers a single domain and splits by cache status instead.

Two kinds of row need care when reading the list:

• node: "" — requests the serving edge did not stamp with a node name. They are counted so the per-node rows still add up to totals, but they cannot be attributed to a point of presence.
• requests: 0 with registered: true — a node that is in service but served nothing in the period. Kept in the list so a node that stopped reporting is visible rather than silently absent.

error_rate and cache_hit_rate are percentages (0–100). Durations are in milliseconds and exclude WebSocket requests, whose lifetime is the whole upgraded connection.

Authorizations

• bearerAuth
• apiKeyAuth

Parameters

Query Parameters

period

string

default: 24h

Allowed values: 3h 6h 12h 24h 7d 30d

Time window, ending now. Buckets are hourly up to 24h and daily for 7d and 30d. An unrecognised value falls back to 24h.

domain_id

integer

Numeric domain id — note this endpoint scopes by id, not by the domain name the rest of the API uses. Omit to cover every active domain you can see.

Responses

200

Per-node totals with the scope-wide total they add up to.

Media type application/json

object

data

Array<object>

object

node

Node identifier. Empty when the serving edge reported no node name.

string

node_label

Human-readable name. Absent for a node that is not registered.

string

country

ISO country code.

string

registered

Whether the name matches a registered edge node.

boolean

active

Whether the registered node is in service.

boolean

requests

integer

bandwidth

Egress bytes.

integer

bytes_in

Bytes received from clients.

integer

unique_visitors

integer

error_rate

Percentage of requests that returned 4xx or 5xx, 0–100.

number

errors_5xx

integer

cache_hit_rate

Percentage of cache lookups served from cache, 0–100.

number

cached_requests

integer

avg_duration

Mean response time in milliseconds, WebSocket requests excluded.

number

p95_duration

95th percentile response time in milliseconds, WebSocket requests excluded.

number

latest_event

Most recent request this node served in scope. Null when it served none.

string format: date-time

series

Traffic over time, one bucket per period step.

Array<object>

object

timestamp

string format: date-time

count

integer

bytes

Egress bytes in the bucket.

integer

top_domains

The busiest domains on this node, at most five.

Array<object>

object

domain_id

integer

domain_name

Empty when the traffic matched no registered domain.

string

requests

integer

bandwidth

Egress bytes.

integer

totals

What the per-node rows add up to over the same scope.

object

requests

integer

bandwidth

Egress bytes.

integer

nodes_with_traffic

integer

unattributed_requests

Requests whose row carried no node name.

integer

Example ^generated

{
  "data": [
    {
      "node": "example",
      "node_label": "example",
      "country": "example",
      "registered": true,
      "active": true,
      "requests": 1,
      "bandwidth": 1,
      "bytes_in": 1,
      "unique_visitors": 1,
      "error_rate": 1,
      "errors_5xx": 1,
      "cache_hit_rate": 1,
      "cached_requests": 1,
      "avg_duration": 1,
      "p95_duration": 1,
      "latest_event": "2026-04-15T12:00:00Z",
      "series": [
        {
          "timestamp": "2026-04-15T12:00:00Z",
          "count": 1,
          "bytes": 1
        }
      ],
      "top_domains": [
        {
          "domain_id": 1,
          "domain_name": "example",
          "requests": 1,
          "bandwidth": 1
        }
      ]
    }
  ],
  "totals": {
    "requests": 1,
    "bandwidth": 1,
    "nodes_with_traffic": 1,
    "unattributed_requests": 1
  }
}

401

Missing, malformed, revoked or expired API key — or the owning account is inactive.

Media type application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

Example invalidKey

{
  "error": "invalid API key"
}

404

No such domain, or it is not visible to this account. Domains you cannot access are reported as not found rather than forbidden.

Media type application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Example

{
  "error": "read-only API key"
}

429

The key exceeded its request budget (300 requests per minute by default).

Media type application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

Example limited

{
  "error": "rate limit exceeded"
}

503

The analytics backend is temporarily unreachable. Retry; no data is lost.

Media type application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

Example unavailable

{
  "error": "analytics unavailable"
}