Skip to main content
Version: Beta

SavedSearchMutation

type SavedSearchMutation {
  create(
    name: String!
    type: CreateSavedSearchType!
    filters: SavedSearchFiltersInput
    alertSetting: AlertSettingInput
    timeToLive: Int
    projectCode: String
  ): SavedSearch!
  delete(
    id: String!
  ): MutationResult!
  update(
    id: String!
    name: String!
    type: SavedSearchType!
    filters: SavedSearchFiltersInput
    alertSetting: AlertSettingInput
    timeToLive: Int
    projectCode: String
  ): SavedSearch!
}

Fields​

SavedSearchMutation.create ● SavedSearch! non-null object​

Save your search @exposed(scopes: ['enterprise-only'])

SavedSearchMutation.create.name ● String! non-null scalar​

Saved Search Name (e.g., COVID Impacts on Financial Risk Management)

SavedSearchMutation.create.type ● CreateSavedSearchType! non-null enum​

Saved search type, e.g., PERSONAL, DASHBOARD, etc.

SavedSearchMutation.create.filters ● SavedSearchFiltersInput input​

Search details, Combination of keyword, companies, document source, Industries, etc.

SavedSearchMutation.create.alertSetting ● AlertSettingInput input​

Alert details for saved search

SavedSearchMutation.create.timeToLive ● Int scalar​

Time To Live is saved search link expiration timestamp in seconds

SavedSearchMutation.create.projectCode ● String scalar​

Project code under which this saved search will be created

SavedSearchMutation.delete ● MutationResult! non-null object​

Delete saved search by ID @exposed(scopes: ['enterprise-only'])

SavedSearchMutation.delete.id ● String! non-null scalar​

SavedSearchMutation.update ● SavedSearch! non-null object​

Update saved search by saved search ID @exposed(scopes: ['enterprise-only'])

SavedSearchMutation.update.id ● String! non-null scalar​

Saved search Id for saved search to be updated

SavedSearchMutation.update.name ● String! non-null scalar​

Saved Search Name (e.g., COVID Impacts on Financial Risk Management)

SavedSearchMutation.update.type ● SavedSearchType! non-null enum​

Saved search type, e.g., PERSONAL, DASHBOARD, etc.

SavedSearchMutation.update.filters ● SavedSearchFiltersInput input​

Search details, Combination of keyword, companies, document source, Industries, etc.

SavedSearchMutation.update.alertSetting ● AlertSettingInput input​

Alert details for saved search

SavedSearchMutation.update.timeToLive ● Int scalar​

Time To Live is saved search link expiration timestamp in seconds

SavedSearchMutation.update.projectCode ● String scalar​

Project code under which this saved search will be updated. Note: for now project code is immutable, so once a saved search has been created under a specific project code, this code will not be updated, but adding it here in case product team want this project code to be mutable

Returned by​

savedSearch mutation