Count users matching filters

client.rawUsers.count(, ?): RawUserCountResponse { count, truncated }

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

body: RawUserCountParams { filters }

filters: UnionMember0 { field, op, value } | UnionMember1 { filters, op } | UnionMember2 { 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 { field, op, value }

field: string

Field name to filter on

op: "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: string | number | Array<string> | Array<number>

Filter value (type depends on field and operator)

Accepts one of the following:

string

number

Array<string>

Array<number>

UnionMember1 { filters, op }

filters: Array<Filter>

Array of field filters

field: string

Field name to filter on

op: "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: string | number | Array<string> | Array<number>

Filter value (type depends on field and operator)

Accepts one of the following:

string

number

Array<string>

Array<number>

op: "And" | "Or"

Composite operator

Accepts one of the following:

"And"

"Or"

UnionMember2 { filters, op }

filters: Array<UnionMember0 { field, op, value } | UnionMember1 { filters, op } >

Array of filters

Accepts one of the following:

UnionMember0 { field, op, value }

field: string

Field name to filter on

op: "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: string | number | Array<string> | Array<number>

Filter value (type depends on field and operator)

Accepts one of the following:

string

number

Array<string>

Array<number>

UnionMember1 { filters, op }

filters: Array<Filter>

Array of field filters

field: string

Field name to filter on

op: "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: string | number | Array<string> | Array<number>

Filter value (type depends on field and operator)

Accepts one of the following:

string

number

Array<string>

Array<number>

op: "And" | "Or"

Composite operator

Accepts one of the following:

"And"

"Or"

op: "And" | "Or"

Composite operator

Accepts one of the following:

"And"

"Or"

ReturnsExpand Collapse

RawUserCountResponse { count, truncated }

count: number

Number of matching records (may be capped or floored)

truncated?: boolean

True if count was capped at maximum or floored at minimum

Count users matching filters

import Bountylab from '@bountylab/bountylab';

const client = new Bountylab({
  apiKey: process.env['BOUNTYLAB_API_KEY'], // This is the default and can be omitted
});

const response = await client.rawUsers.count({ filters: { field: 'field', op: 'Eq', value: 'string' } });

console.log(response.count);

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

Returns Examples

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