Create a Search

Creates a new Search for the Webset.

The default behavior is to reuse the previous Search results and evaluate them against the new criteria.

websetstring required

The id of the Webset

Request body

countnumber required

Number of Items the Search will attempt to find.

The actual number of Items found may be less than this number depending on the query complexity.

querystring required

Natural language search query describing what you are looking for.

Be specific and descriptive about your requirements, characteristics, and any constraints that help narrow down the results.

Any URLs provided will be crawled and used as additional context for the search.

maxPeoplePerCompanyinteger

Optional soft cap for people searches. When set, the search will try to include at most this many matching people from the same current employer company.

recallboolean

Whether to provide an estimate of how many total relevant results could exist for this search. Result of the analysis will be available in the recall field within the search request.

behavior'override' | 'append'

metadataobject

Set of key-value pairs you want to associate with this object.

Example request

{
  "query": "Marketing agencies based in the US, that focus on consumer products. Get brands worked with and city"
}

Response

Webset Search created

idstring required

The unique identifier for the search

object'webset_search' required

status'created' | 'pending' | 'running' | 'completed' | 'canceled' required

The status of the search

websetIdstring required

The unique identifier for the Webset this search belongs to

querystring required

The query used to create the search.

countnumber required

The number of results the search will attempt to find. The actual number of results may be less than this number depending on the search complexity.

maxPeoplePerCompanyinteger nullable required

The soft cap requested for matching people from the same current employer company, or null when no cap was requested.

behavior'override' | 'append'

metadataobject

Set of key-value pairs you want to associate with this object.

canceledAtstring date-time nullable required

The date and time the search was canceled

canceledReason'webset_deleted' | 'webset_canceled' | 'out_of_credits' required

createdAtstring date-time required

The date and time the search was created

updatedAtstring date-time required

The date and time the search was updated

v2

Create a Search

Path parameters

Request body

Example request

Response