Skip to main content
Version: Latest

SearchFilter

input SearchFilter {
  keyword: KeywordFilter
  companies: CompanyFilter
  date: DateFilter
  industries: [String!]
  countries: [String!]
  types: DocTypesFilter
  sources: DocSourcesFilter
  brokers: BrokerFilter
  documentAuthors: [String!]
  expertInsightsFilters: ExpertInsightsFilters
}

Fields​

SearchFilter.keyword ● KeywordFilter input​

SearchFilter.companies ● CompanyFilter input​

SearchFilter.date ● DateFilter input​

SearchFilter.industries ● [String!] list scalar​

Use GICS to pass a list of required industries. Supports filter preset enum values also. e.g. ["ALL/DEFAULT/SYSTEM_DEFAULT"]. Please avoid combination of preset and country codes. e.g. [“DEFAULT“, <SOME_GICS_CODE>]

SearchFilter.countries ● [String!] list scalar​

Use country codes to pass a list of required countries. Country code format is uppercase 2 letter symbol, for example: FI,US,CA For United States (non-US domicile) use US* Supports filter preset enum values also. e.g. ["ALL/DEFAULT/SYSTEM_DEFAULT"]. Please avoid combination of preset and country codes. e.g. [“DEFAULT“, <COUNTRY_CODE>]

SearchFilter.types ● DocTypesFilter input​

Use types to pass a list of required document types

SearchFilter.sources ● DocSourcesFilter input​

Use sources to pass a list of required document sources. Sources and Types are not the same fields! For some specific parents they hold different set of ids.

SearchFilter.brokers ● BrokerFilter input​

Use brokers to pass a list of required broker codes. Brokers and factset brokers are used separately. They look similar however they are different fields. We do use them as this in every other service and in the FE

SearchFilter.documentAuthors ● [String!] list scalar​

List of Authors associated with user documents. e.g "Craig Farrell". This is affecting only user documents and have no effect on public document types. In case of having nluEnabled this value will be overridden.

SearchFilter.expertInsightsFilters ● ExpertInsightsFilters input​

Use expert insights filters to filter documents based on expert perspectives, analyst perspectives and expert transcript type

Member of​

documentCountsInSearchResults query ● search query ● SearchDocumentImageFilter input