v1

latestOpenAPI 3.1.02026-08-04253331435.1 KB

Signal Settings

Get Signal Stats For User

Get all signal stats grouped by signal setting for user

get/api/v3/signal-settings/users/{user_id}/stats

Path parameters

user_idstring nullable required

Query parameters

created_afterstring date-time nullable

created_beforestring date-time nullable

offsetinteger

limitinteger nullable

savedboolean nullable

sort_by'created_at_desc' | 'created_at_asc'

institution_sort'most_signals' | 'most_recent' | 'oldest' | 'most_contacts' | 'account_type'

Sort order for institutions in paginated response.

Note: This sorting is applied per-page after signal-level pagination. The same institution may appear on multiple pages if its signals span pages.

querystring nullable

Request body

statusesSignalStatusEnum[] nullable

signal_idsstring[] nullable

signal_setting_idsstring[] nullable

list_idsstring[] nullable

data_sourcesSignalSourceType[] nullable

institution_typesInstitutionEnum[] nullable

keywordsstring[] nullable

statesstring[] nullable

exclude_territory_idsstring[] nullable

exclude_institution_idsstring[] nullable

Response

Successful Response

{"stackTrail":"paths:/api/v3/signal-settings/users/{user_id}/stats:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}