Why requests could not be served

GET

/analytics/unreachable-reasons

const url = 'https://api.nsin.ir/analytics/unreachable-reasons?domain=example.com&period=3h';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

A breakdown of failed requests by cause, with plain-language explanations and who is responsible (client, origin, network or config) — so you can tell a visitor hanging up from your server crashing without reading raw proxy errors.

Authorizations

bearerAuth
apiKeyAuth

Parameters

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

200

Failure reasons.

application/json

object

data

Array<object>

object

reason

Canonical key, e.g. origin_closed.

string

label

Short headline.

string

fault

Who is responsible.

string

Allowed values: client origin network config

meaning

Plain-language explanation.

string

count

integer

status

Representative HTTP status the visitor saw.

integer

Example

{
  "data": [
    {
      "fault": "client"
    }
  ]
}

400

The domain query parameter is missing.

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

missing

{
  "error": "domain is required"
}

401

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

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

invalidKey

{
  "error": "invalid API key"
}

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).

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

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

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).

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

limited

{
  "error": "rate limit exceeded"
}

503

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

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

unavailable

{
  "error": "analytics unavailable"
}