Count users matching filters

POST/raw/users/count

Count users in the database matching filters. Counts are capped at minimum (10k) and maximum (1M). Requires RAW service. Credits: 1 per request.

Body ParametersExpand Collapse

filters: object { field, op, value } or object { filters, op } or object { filters, op }

Optional filters for users. Supports fields like login, company, location, resolvedCountry, resolvedState, resolvedCity. Operators: Eq, NotEq, In, NotIn, Lt, Lte, Gt, Gte.

Accepts one of the following:

UnionMember0 = object { field, op, value }

field: string

Field name to filter on

op: "Eq" or "NotEq" or "In" or 19 more

Filter operator

Accepts one of the following:

"Eq"

"NotEq"

"In"

"NotIn"

"Lt"

"Lte"

"Gt"

"Gte"

"Glob"

"NotGlob"

"IGlob"

"NotIGlob"

"Regex"

"Contains"

"NotContains"

"ContainsAny"

"NotContainsAny"

"AnyLt"

"AnyLte"

"AnyGt"

"AnyGte"

"ContainsAllTokens"

value: string or number or array of string or array of number

Filter value (type depends on field and operator)

Accepts one of the following:

UnionMember0 = string

UnionMember1 = number

UnionMember2 = array of string

UnionMember3 = array of number

UnionMember1 = object { filters, op }

filters: array of object { field, op, value }

Array of field filters

field: string

Field name to filter on

op: "Eq" or "NotEq" or "In" or 19 more

Filter operator

Accepts one of the following:

"Eq"

"NotEq"

"In"

"NotIn"

"Lt"

"Lte"

"Gt"

"Gte"

"Glob"

"NotGlob"

"IGlob"

"NotIGlob"

"Regex"

"Contains"

"NotContains"

"ContainsAny"

"NotContainsAny"

"AnyLt"

"AnyLte"

"AnyGt"

"AnyGte"

"ContainsAllTokens"

value: string or number or array of string or array of number

Filter value (type depends on field and operator)

Accepts one of the following:

UnionMember0 = string

UnionMember1 = number

UnionMember2 = array of string

UnionMember3 = array of number

op: "And" or "Or"

Composite operator

Accepts one of the following:

"And"

"Or"

UnionMember2 = object { filters, op }

filters: array of object { field, op, value } or object { filters, op }

Array of filters

Accepts one of the following:

UnionMember0 = object { field, op, value }

field: string

Field name to filter on

op: "Eq" or "NotEq" or "In" or 19 more

Filter operator

Accepts one of the following:

"Eq"

"NotEq"

"In"

"NotIn"

"Lt"

"Lte"

"Gt"

"Gte"

"Glob"

"NotGlob"

"IGlob"

"NotIGlob"

"Regex"

"Contains"

"NotContains"

"ContainsAny"

"NotContainsAny"

"AnyLt"

"AnyLte"

"AnyGt"

"AnyGte"

"ContainsAllTokens"

value: string or number or array of string or array of number

Filter value (type depends on field and operator)

Accepts one of the following:

UnionMember0 = string

UnionMember1 = number

UnionMember2 = array of string

UnionMember3 = array of number

UnionMember1 = object { filters, op }

filters: array of object { field, op, value }

Array of field filters

field: string

Field name to filter on

op: "Eq" or "NotEq" or "In" or 19 more

Filter operator

Accepts one of the following:

"Eq"

"NotEq"

"In"

"NotIn"

"Lt"

"Lte"

"Gt"

"Gte"

"Glob"

"NotGlob"

"IGlob"

"NotIGlob"

"Regex"

"Contains"

"NotContains"

"ContainsAny"

"NotContainsAny"

"AnyLt"

"AnyLte"

"AnyGt"

"AnyGte"

"ContainsAllTokens"

value: string or number or array of string or array of number

Filter value (type depends on field and operator)

Accepts one of the following:

UnionMember0 = string

UnionMember1 = number

UnionMember2 = array of string

UnionMember3 = array of number

op: "And" or "Or"

Composite operator

Accepts one of the following:

"And"

"Or"

op: "And" or "Or"

Composite operator

Accepts one of the following:

"And"

"Or"

ReturnsExpand Collapse

count: number

Number of matching records (may be capped or floored)

truncated: optional boolean

True if count was capped at maximum or floored at minimum

Count users matching filters

curl https://api.bountylab.io/v2/raw/users/count \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $BOUNTYLAB_API_KEY" \
    -d '{
          "filters": {
            "field": "field",
            "op": "Eq",
            "value": "string"
          }
        }'

{
  "count": 0,
  "truncated": true
}

Returns Examples

{
  "count": 0,
  "truncated": true
}