Account-wide summary
const url = 'https://api.nsin.ir/analytics/global-summary?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/global-summary?period=3h' \ --header 'Authorization: Bearer <token>'Headline figures aggregated across every domain you can access.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ”Time window, ending now. Buckets are hourly up to 24h and daily for
7d and 30d. An unrecognised value falls back to 24h.
Responses
Section titled “ Responses ”Account-wide totals.
object
Bytes.
Share of requests that failed, 0–1.
Share of cacheable requests served from cache, 0–1.
Highest request count in any single second of the period.
How many domains contributed.
Example generated
{ "total_requests": 1, "total_bandwidth": 1, "unique_visitors": 1, "error_rate": 1, "cache_hit_rate": 1, "peak_rps": 1, "domains": 1}Missing, malformed, revoked or expired API key — or the owning account is inactive.
The single error shape used by every endpoint.
object
Human-readable description of what went wrong.
Examples
{ "error": "invalid API key"}The key exceeded its request budget (300 requests per minute by default).
The single error shape used by every endpoint.
object
Human-readable description of what went wrong.
Examples
{ "error": "rate limit exceeded"}The analytics backend is temporarily unreachable. Retry; no data is lost.
The single error shape used by every endpoint.
object
Human-readable description of what went wrong.
Examples
{ "error": "analytics unavailable"}