Skip to content

Preview Search Signal

POST
/search/signals/preview

How many companies one signal matches on its own, before any other filter.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

One signal. Which list must be non-empty depends on type.

object
categories

Company_type: category ids.

Array<string>
days

Hiring / new_in_role: look-back window.

integer
default: 30 >= 1 <= 730
domains

Lookalike: seed company domains.

Array<string>
exclude_staffing
boolean
default: true
facet
string
default: what
Allowed values: what sells serves
match
string
default: any
Allowed values: any all
min_roles
integer
default: 1 >= 1 <= 100
negate

Match companies WITHOUT the signal (hiring, tech, company_type).

boolean
roles

Hiring: role titles.

Array<string>
status
string
default: new
Allowed values: new open
techs

Tech: technologies.

Array<string>
text

Describes: what the companies do.

string
""
top_k
integer
default: 300 >= 10 <= 5000
type
required
string
Allowed values: hiring tech company_type describes lookalike new_in_role

Responses

200

Successful Response

object
data
required

Search results, grouped the way the app groups them.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string