Skip to content
nsin nsin nsin Docs

Edge-to-origin request statistics

GET
/analytics/origins
 
curl --request GET \
  --url 'https://api.nsin.ir/analytics/origins?domain=example.com&period=3h' \
  --header 'Authorization: Bearer <token>'

How each of your origin addresses is performing as seen from the edge — request counts, failures, server errors and upstream latency — with the per-node split that produced them.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
domain
required
string

The domain name (for example example.com). These endpoints take the domain as a query parameter rather than a path segment.

Example 
example.com
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.

node
string

Narrow to one edge node. Use name from GET /analytics/nodes.

hostname
string

Narrow to one subdomain. Matches the exact host, any subdomain of it, or a bare label — so example.com matches api.example.com, and api matches api.example.com, but exam matches neither.

path
string

Narrow to a URL path prefix.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Per-origin statistics.

Media type application/json
object
data
Array<object>
object
origin_addr
string
requests
integer
failed
integer
errors_5xx
integer
avg_upstream

Mean origin response time, ms.

number
p95_upstream

95th percentile origin response time, ms.

number
bytes_down
integer
nodes

The per-edge-node split behind these totals.

Array<object>
object
node
string
node_label
string
country
string
requests
integer
failed
integer
errors_5xx
integer
avg_upstream

Mean origin response time, ms.

number
bytes_down

Bytes received from the origin.

integer
Example generated
{
  "data": [
    {
      "origin_addr": "example",
      "requests": 1,
      "failed": 1,
      "errors_5xx": 1,
      "avg_upstream": 1,
      "p95_upstream": 1,
      "bytes_down": 1,
      "nodes": [
        {
          "node": "example",
          "node_label": "example",
          "country": "example",
          "requests": 1,
          "failed": 1,
          "errors_5xx": 1,
          "avg_upstream": 1,
          "bytes_down": 1
        }
      ]
    }
  ]
}

400

Section titled “400 ”

The domain query parameter is missing.

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 missing 
{
  "error": "domain is required"
}

401

Section titled “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"
}

403

Section titled “403 ”

The domain’s plan does not include the feature this endpoint needs (monitoring for most sections, logs for raw and top-N request data).

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"
}

404

Section titled “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

Section titled “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

Section titled “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"
}