Skip to content
nsin nsin nsin Docs

Traffic summary for one domain

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

Headline figures for the domain over the period: requests, bandwidth, unique visitors, error rate and latency percentiles.

Unique visitors are counted as distinct (client IP, JA4 TLS fingerprint) pairs, which separates people sharing one NAT address by device. On plain HTTP there is no JA4, so it degrades to counting IPs. Latency figures exclude WebSocket requests, whose duration spans the whole connection.

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.

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 ”

Summary figures.

Media type application/json
object
total_requests
integer
total_bandwidth

Bytes.

integer
unique_visitors
integer
error_rate

Share of requests that failed, 0–1.

number
avg_response_time

Mean response time in milliseconds.

number
p90

90th percentile response time, ms.

number
p95

95th percentile response time, ms.

number
p99

99th percentile response time, ms.

number
Example generated
{
  "total_requests": 1,
  "total_bandwidth": 1,
  "unique_visitors": 1,
  "error_rate": 1,
  "avg_response_time": 1,
  "p90": 1,
  "p95": 1,
  "p99": 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"
}