Skip to content
bountylab
Get started
API Reference
Raw Users

Count users matching filters

raw_users.count(RawUserCountParams**kwargs) -> RawUserCountResponse
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.

ParametersExpand Collapse
filters: Filters

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:
class FiltersUnionMember0: …
field: str

Field name to filter on

op: Literal["Eq", "NotEq", "In", 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: Union[str, float, SequenceNotStr[str], Iterable[float]]

Filter value (type depends on field and operator)

Accepts one of the following:
str
float
SequenceNotStr[str]
Iterable[float]
class FiltersUnionMember1: …
filters: Iterable[FiltersUnionMember1Filter]

Array of field filters

field: str

Field name to filter on

op: Literal["Eq", "NotEq", "In", 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: Union[str, float, SequenceNotStr[str], Iterable[float]]

Filter value (type depends on field and operator)

Accepts one of the following:
str
float
SequenceNotStr[str]
Iterable[float]
op: Literal["And", "Or"]

Composite operator

Accepts one of the following:
"And"
"Or"
class FiltersUnionMember2: …
filters: Iterable[FiltersUnionMember2Filter]

Array of filters

Accepts one of the following:
class FiltersUnionMember2FilterUnionMember0: …
field: str

Field name to filter on

op: Literal["Eq", "NotEq", "In", 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: Union[str, float, SequenceNotStr[str], Iterable[float]]

Filter value (type depends on field and operator)

Accepts one of the following:
str
float
SequenceNotStr[str]
Iterable[float]
class FiltersUnionMember2FilterUnionMember1: …
filters: Iterable[FiltersUnionMember2FilterUnionMember1Filter]

Array of field filters

field: str

Field name to filter on

op: Literal["Eq", "NotEq", "In", 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: Union[str, float, SequenceNotStr[str], Iterable[float]]

Filter value (type depends on field and operator)

Accepts one of the following:
str
float
SequenceNotStr[str]
Iterable[float]
op: Literal["And", "Or"]

Composite operator

Accepts one of the following:
"And"
"Or"
op: Literal["And", "Or"]

Composite operator

Accepts one of the following:
"And"
"Or"
ReturnsExpand Collapse
class RawUserCountResponse: …
count: int

Number of matching records (may be capped or floored)

truncated: Optional[bool]

True if count was capped at maximum or floored at minimum

Count users matching filters
import os
from bountylab import Bountylab

client = Bountylab(
    api_key=os.environ.get("BOUNTYLAB_API_KEY"),  # This is the default and can be omitted
)
response = client.raw_users.count(
    filters={
        "field": "field",
        "op": "Eq",
        "value": "string",
    },
)
print(response.count)
{
  "count": 0,
  "truncated": true
}
Returns Examples
{
  "count": 0,
  "truncated": true
}