Stats

post

https://api.smarte.pro/v2/discover/stats

The Stats API returns counts and aggregated data for person and company records based on the filters provided.

The response includes total counts for persons and companies. Aggregation is supported using the aggregateBy field:

Up to 2 aggregation fields are supported
If no aggregation is provided, only total counts are returned

Body Params

Request body for the stats endpoint. At least one of personFilters or companyFilters must be provided.

personFilters

object

Person-level search filters. All fields are optional; combine multiple fields to narrow results (AND logic across fields).

companyFilters

object

Company-level search filters. All fields are optional; combine multiple fields to narrow results (AND logic across fields). At least one field must be set when this object is used as companyFilters in the company endpoint.

suppression

object

Suppression list configuration. When enabled, records whose identifiers appear in the specified lists are excluded from the response and counted in totalSuppressed. List IDs must be prefixed with the matching endpoint scope: person_ for the person endpoint, company_ for the company endpoint.

aggregateBy

array of strings

length ≤ 2

List of up to 2 fields to aggregate results by. When 2 fields are provided, company-scope fields (companyRegion, companyCountry, industry, globalHeadcount, globalRevenue) always form the outer grouping level. The ordering of values in this array does not affect nesting — nesting is determined by scope hierarchy.
Company-scope fields: companyRegion, companyCountry, industry, globalHeadcount, globalRevenue
Person-scope fields: workRegion, workCountry, department, seniorityLevel

aggregateBy

Headers

apikey

string

required

API key issued by SMARTe. Pass in the apikey request header.

Responses

200Success — counts and optional aggregation.

400Bad Request — one or more request fields are missing or invalid.

401Unauthorized — apikey header is missing, blank, or invalid.

404Not Found — stats query returned zero results, or a suppression list ID does not exist.

409Conflict — a suppression list ID's scope does not match the endpoint (e.g. a person_ list ID used on the company endpoint).

429Too Many Requests — rate limit exceeded.

500Internal Server Error.