Count contacts matching filters

Preview how many contacts match a set of segment filters without creating or saving a segment.

POST /v1/my/segments/count

Count contacts matching filters

cURL

curl --request POST \
  --url https://api.nitrosend.com/v1/my/segments/count \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": [
    {
      "name": "<string>",
      "predicate": "<string>",
      "value": "<unknown>"
    }
  ]
}
'

200

{
  "count": 123
}

Authorizations

Authorization · string · header · required

API key (nskey_live_...) or JWT token. API key is checked first; if not found, falls back to Devise JWT authentication.

Body

application/json

filters · object[]

Show child attributes

Response

200 - application/json

Contact count

count · integer