Account-wide peak requests per second

GET

/analytics/global-summary/peak

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

• Production

The highest number of requests served in any single second of the period, across the same domains /analytics/global-summary covers.

This is a full scan of the request log rather than a lookup, so it is served on demand and may take a while for long periods. Results are cached per account; all is refreshed at most once a day.

Authorizations

• bearerAuth
• apiKeyAuth

Parameters

Query Parameters

period

string

default: 24h

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

Time window, ending now. Same values as /analytics/global-summary, plus all for the whole retained history. An unrecognised value falls back to 24h.

Responses

200

Peak requests per second.

Media type application/json

object

peak_rps

Highest request count in any single second of the period.

integer

Example ^generated

{
  "peak_rps": 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"
}

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