Add a new saved search

Creates a saved search with the specified name, visibility settings, and search criteria. The search criteria (query, filters, sort fields, etc.) are stored so the search can be re-executed later. Supports pagination, scoring, and custom result field selection.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The name of the saved search

boolean
required

Whether the saved search is bookmarked

boolean
required

Sent, but not applied: the API's saved search add model has no public field

integer
required

The display order sequence number

integer
required

Sent, but not applied when adding: the add model has no display type

string

The search query string (stored as searchTerms and as the criteria's searchQuery)

integer

The page offset for pagination (stored in criteria, defaults to 0)

integer

The page size for results (stored in criteria, defaults to 10)

filters
array of objects

An array of search filters (stored in criteria), or an advanced-search filter object (sent as advanceSearchFilters)

filters
sortFields
array of objects

An array of sort fields (stored in criteria), or a sort field name (sent as sortField)

sortFields
searchResultFields
array of strings

Array of field names to include in results (stored in criteria)

searchResultFields
string

The ID of an asset to find similar results for (stored in criteria)

integer

The minimum relevance score threshold for results (stored in criteria)

boolean

Whether to exclude the total record count (stored in criteria)

string

The logical binder for combining filters (stored in criteria)

Responses
200

Success

400

Bad Request

401

The caller is not authenticated

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!