Skip to content
nsin nsin nsin Docs

Per-domain totals across your account

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

One row per domain you can access, with request, bandwidth and visitor totals for the period. Account-wide — takes no domain parameter.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
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.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

One entry per domain.

Media type application/json
object
data
Array<object>
object
domain_id
integer
domain_name
string
total_requests
integer
total_bandwidth

Bytes.

integer
unique_visitors
integer
Example generated
{
  "data": [
    {
      "domain_id": 1,
      "domain_name": "example",
      "total_requests": 1,
      "total_bandwidth": 1,
      "unique_visitors": 1
    }
  ]
}

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

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