Skip to main content
POST
Suggest a name for a lead search's table

Authorizations

X-API-Key
string
header
required

Body

application/json

A search to name a table after, with the builder's picks and the viewer's zone.

The builder offers seniority, job function and region as picks, and a search sends each one as what it stands for: job titles, or a region's countries. The first of those names a search badly ("Founder" for a C-suite search, "United States" for North America), so the picks travel here by name instead, and the name reads them.

record_type
enum<string>
required

Which dataset a search runs against, and so which provider serves it.

Values are persisted in String(16) columns, so every member must stay within 16 characters.

Available options:
people,
companies,
signal_companies,
signal_people,
lookalikes,
local_businesses,
hiring_companies,
backlinks

The sites linking to a domain or a page.

Name the target and get one row per referring site by default, sorted by the rank the link passes. Every attribute of a backlink the index can filter on is here, in four groups: the referring site, the referring page, the link itself, and the page it points at. The index takes at most eight filter conditions in one search, counting every value of every list as one; a ninth is refused rather than dropped.

companies
CompanyQuerySchema · object | null

Filters for a company search.

hiring_companies
HiringCompaniesQuerySchema · object | null

Filters for a search for companies with open roles matching a job title.

The rows are companies, one per employer, each carrying every open posting the search read for it. The count is of open postings, since the companies are folded from them once they are read.

job_functions
string[]

The job functions a people search was built from ('Sales', 'Engineering'), on the same terms as seniority.

Maximum array length: 200
Required string length: 1 - 255
local_businesses
LocalBusinessQuerySchema · object | null

Filters for a map search over business listings.

The one search here that asks "who is within this radius". Name a category, a business name or a website to look for, plus an area to look in for the radius part.

lookalikes
LookalikeQuerySchema · object | null

Filters for a search for companies resembling a set of seed companies.

people
PeopleQuerySchema · object | null

Filters for a people search.

regions
string[]

The regions a people or company search's places were picked as, as the builder names them ('NAM (North America)'). The first names the place in place of the countries it stands for. Ignored on every other search.

Maximum array length: 200
Required string length: 1 - 255
seniority
string[]

The seniority levels a people search was built from, as the builder names them ('C-suite', 'VP'). Leave the job titles they stand for out of people.job_title, or the first of those titles names the table too. Ignored on every other search.

Maximum array length: 200
Required string length: 1 - 255
signal_companies
SignalCompaniesQuerySchema · object | null

Filters for a company buying-signal search.

signal_people
SignalPeopleQuerySchema · object | null

Filters for a person activity-signal search.

timezone
string
default:UTC

The viewer's IANA time zone, such as Europe/Berlin. A search named by nothing else is dated with today's date there.

Required string length: 1 - 64

Response

Successful Response

The name a table would take from the search that fills it.

suggested_name
string
required

The search's most telling filters, joined with commas, or what its rows are and today's date when it has none.