Skip to content
nsin docs
EN فا

Count outstanding recommendations

GET
/recommendations/count
 
curl --request GET \
  --url 'https://api.nsin.ir/recommendations/count?domain=example.com' \
  --header 'Authorization: Bearer <token>'

How many of the domain’s checklist items need action for you: warn items you have not dismissed. Cheap enough to poll — it only reads the cached checklist. Requires domain.view.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
domain
required
string

The domain name (for example example.com). These endpoints take the domain as a query parameter rather than a path segment.

Example 
example.com

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Outstanding count.

Media type application/json
object
count
integer
computing

Present (and true) only when the checklist for this domain has not been computed yet: the server has started computing it in the background and count is 0 for now. Poll again; the field disappears once the checklist exists. This endpoint never computes the checklist itself — it is polled by the panel’s sidebar badge from every page — so its answer is always immediate.

boolean
Example generated
{
  "count": 1,
  "computing": true
}

400

Section titled “400 ”

The domain query parameter is missing.

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 missing 
{
  "error": "domain is required"
}

401

Section titled “401 ”

Missing, malformed, revoked or expired API key. (A valid key whose account has been deactivated gets 403 account is inactive instead.)

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

404

Section titled “404 ”

No such domain, or it is not visible to this account. Domains you cannot access are reported as not found rather than forbidden.

Media type application/json

The single error shape used by every endpoint.

object
error
required

Human-readable description of what went wrong.

string
Example 
{
  "error": "read-only 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"
}