Skip to content

Latest commit

 

History

History
92 lines (61 loc) · 4.41 KB

filter-sources.md

File metadata and controls

92 lines (61 loc) · 4.41 KB

Filter sources

You can filter sources with the filter parameter:

{% hint style="info" %} It's best to read about filters before trying these out. It will show you how to combine filters and build an AND, OR, or negation query {% endhint %}

/sources attribute filters

You can filter using these attributes of the Source entity object (click each one to view their documentation on the Source object page):

{% hint style="info" %} Want to filter by host_organization.display_name? This is a two-step process:

  1. Find the host organization's ID by searching by display_name in Publishers or Institutions, depending on which type you are looking for.
  2. Filter works by host_organization.id.

To learn more about why we do it this way, see here. {% endhint %}

/sources convenience filters

These filters aren't attributes of the Source object, but they're included to address some common use cases:

continent

Value: a String with a valid continent filter

Returns: sources that are associated with the chosen continent.

default.search

Value: a search string

This works the same as using the search parameter for Sources.

display_name.search

Value: a search string

Returns: sources with a display_name containing the given string; see the search page for details.

{% hint style="info" %} In most cases, you should use the search parameter instead of this filter because it uses a better search algorithm. {% endhint %}

has_issn

Value: a Boolean (true or false)

Returns: sources that have or lack an ISSN, depending on the given value.

is_global_south

Value: a Boolean (true or false)

Returns: sources that are associated with the Global South.