Skip to content
nsin nsin nsin Docs

Traffic usage and pricing across your account

GET
/traffic-usage
 
curl --request GET \
  --url https://api.nsin.cloud/traffic-usage \
  --header 'Authorization: Bearer <token>'

Recent daily traffic rows (up to 90) with totals, plus the current per-gigabyte prices.

Traffic is billed in three tiers — cached (served from cache), proxied (fetched through the edge proxy) and direct — each priced separately. Older rows may carry only the legacy bypass_bytes column; those are folded into the direct total.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Usage rows, totals and prices.

Media type application/json
object
usage
Array<object>

One day’s traffic for one domain.

object
id
integer
domain_id
integer
user_id
integer
date
string format: date
billing_window_key
string
cached_bytes
integer
proxied_bytes
integer
direct_bytes
integer
bypass_bytes

Legacy two-tier column, present on historical rows. Folded into the direct total for display.

integer
charged_rials
integer
window_start
string format: date-time
window_end
string format: date-time
billed_cached_bytes

The portion above the plan’s free allowance.

integer
billed_proxied_bytes

The portion above the plan’s free allowance.

integer
billed_direct_bytes

The portion above the plan’s free allowance.

integer
charged_cached_rials
integer
charged_proxied_rials
integer
charged_direct_rials
integer
invoice_id
integer
processed_at
string format: date-time
created_at
string format: date-time
total_cached_bytes
integer
total_proxied_bytes
integer
total_direct_bytes
integer
total_charged_rials
integer
cached_price_per_gb

Rials per GB of cache-served traffic.

integer
proxied_price_per_gb

Rials per GB of proxied traffic.

integer
direct_price_per_gb

Rials per GB of direct traffic.

integer
Example generated
{
  "usage": [
    {
      "id": 1,
      "domain_id": 1,
      "user_id": 1,
      "date": "2026-04-15",
      "billing_window_key": "example",
      "cached_bytes": 1,
      "proxied_bytes": 1,
      "direct_bytes": 1,
      "bypass_bytes": 1,
      "charged_rials": 1,
      "window_start": "2026-04-15T12:00:00Z",
      "window_end": "2026-04-15T12:00:00Z",
      "billed_cached_bytes": 1,
      "billed_proxied_bytes": 1,
      "billed_direct_bytes": 1,
      "charged_cached_rials": 1,
      "charged_proxied_rials": 1,
      "charged_direct_rials": 1,
      "invoice_id": 1,
      "processed_at": "2026-04-15T12:00:00Z",
      "created_at": "2026-04-15T12:00:00Z"
    }
  ],
  "total_cached_bytes": 1,
  "total_proxied_bytes": 1,
  "total_direct_bytes": 1,
  "total_charged_rials": 1,
  "cached_price_per_gb": 1,
  "proxied_price_per_gb": 1,
  "direct_price_per_gb": 1
}

401

Section titled “401 ”

Missing, malformed, revoked or expired API key, or a key whose owning user row is gone. A key whose owning account has merely been deactivated is not this: that is 403 with code: account_suspended, because the credential itself is intact and re-issuing it changes nothing.

Media type application/json

The error shape used by every endpoint. error is always present. code is present only on the failures that have one — do not require it, and do not parse error to recover it.

object
error
required

Human-readable description of what went wrong.

string
code

Stable machine-readable reason. Present on some failures only; the wording of error may change, this will not.

  • account_suspended — 403. The account behind the credential has been switched off, by an admin or by its provider. Every authenticated route answers this, so treat it as terminal rather than retrying.
  • domain_disabled — 409, not 403. You have every right to the operation; the domain is simply switched off and is not being served, so its configuration cannot change. It stays readable, and writes work again once it is enabled.
  • managed_by_reseller — 403. The account is a reseller’s client and this surface belongs to its provider. See If your account is managed by a reseller.
  • invite_email_mismatch — 403 from POST /invites/{token}/accept. The invitation was addressed to a different email; the body also carries invited_email, masked.

A panel session — not an API key — can additionally see session_check_failed on a 503, which means the session could not be verified, not that it is invalid. Retry it; do not discard the token.

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 error shape used by every endpoint. error is always present. code is present only on the failures that have one — do not require it, and do not parse error to recover it.

object
error
required

Human-readable description of what went wrong.

string
code

Stable machine-readable reason. Present on some failures only; the wording of error may change, this will not.

  • account_suspended — 403. The account behind the credential has been switched off, by an admin or by its provider. Every authenticated route answers this, so treat it as terminal rather than retrying.
  • domain_disabled — 409, not 403. You have every right to the operation; the domain is simply switched off and is not being served, so its configuration cannot change. It stays readable, and writes work again once it is enabled.
  • managed_by_reseller — 403. The account is a reseller’s client and this surface belongs to its provider. See If your account is managed by a reseller.
  • invite_email_mismatch — 403 from POST /invites/{token}/accept. The invitation was addressed to a different email; the body also carries invited_email, masked.

A panel session — not an API key — can additionally see session_check_failed on a 503, which means the session could not be verified, not that it is invalid. Retry it; do not discard the token.

string
Examples
Example limited 
{
  "error": "rate limit exceeded"
}