Skip to content
Detent

Get namespace usage stats

GET
/v1/namespaces/{ns}/stats
curl --request GET \
  --url https://example.com/v1/namespaces/example/stats \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
ns
required
string

Namespace name

Responses

Section titled “Responses”

200

Section titled “200”

Aggregated daily usage + month/quota rollup (§4.2)

Media typeapplication/json
object
blocked
required
integer format: int64
days
required
Array<object>
object
blocked
required
integer format: int64
day
required
string
total
required
integer format: int64
month
required

Current-month rollup + soft-quota state (§4.2), per account (across all namespaces). This is the data source for the dashboard quota banner.

object
hard_cap

§4.2 anti-abuse ceiling for this plan; None when unconfigured.

integer | null format: int64
month
required
string
over_quota
required
boolean
quota
integer | null format: int64
total
required
integer format: int64
namespace
required
string
total
required
integer format: int64
Examplegenerated
{
  "blocked": 1,
  "days": [
    {
      "blocked": 1,
      "day": "example",
      "total": 1
    }
  ],
  "month": {
    "hard_cap": 1,
    "month": "example",
    "over_quota": true,
    "quota": 1,
    "total": 1
  },
  "namespace": "example",
  "total": 1
}

401

Section titled “401”

Missing or invalid API key

Media typeapplication/json

The JSON body returned for every error response: { "error": "<message>" }, optionally with a stable machine code ({ "error": ..., "code": ... }). The code lets clients map an error to their own localized copy instead of showing the English error string; it is present only for errors we’ve assigned a stable code, and omitted otherwise.

object
code

Stable machine-readable error code for client-side localization, when one is defined for this error (e.g. key_not_found, algorithm_not_on_plan).

string | null
error
required

Human-readable error message. Never contains internal/driver detail.

string
Examplegenerated
{
  "code": "example",
  "error": "example"
}