Skip to content
nsin nsin nsin Docs

Top-N breakdown by a chosen metric

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

A ranked breakdown of the domain’s traffic. metric selects what is ranked, and which fields of each row are populated — rows omit the fields that do not apply.

Requires a plan including the logs feature.

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
metric
required
string
Allowed values: slow_requests uris errors_5xx hosts countries user_agents networks
  • slow_requests — slowest paths, with average and maximum duration. Excludes WebSockets.
  • uris — most requested paths.
  • errors_5xx — paths returning server errors.
  • hosts — busiest subdomains.
  • countries — busiest visitor countries.
  • user_agents — busiest user agents.
  • networks — busiest visitor networks, keyed AS<number> with the operator in label.
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 ”

Ranked rows.

Media type application/json
object
data
Array<object>

One ranked row. Which fields are populated depends on the metric — the rest are omitted.

object
key

The ranked value — path, country, user agent, hostname or AS<number>.

string
label

Network operator name, for the networks metric.

string
hostname

Owning host, for path-based metrics.

string
asn
integer
requests
integer
bytes
integer
avg_duration

Milliseconds.

number
max_duration

Milliseconds.

number
Example generated
{
  "data": [
    {
      "key": "example",
      "label": "example",
      "hostname": "example",
      "asn": 1,
      "requests": 1,
      "bytes": 1,
      "avg_duration": 1,
      "max_duration": 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"
}