The filters API is broken into two broad sections.
- The Filters API - this refers to functionality concerned with the filter container object and all of the filters within it (could be one or more filters)
- The Filters Object API - this refers to functionality concerned with an individual filter
Filters Overview
Filters are used in Yellowfin to restrict the data returned in a report to the exact data that a user is interested in (for example, restricting time periods to just return data for the last quarter, or restricting to a list of countries that a user has responsibility for). You can learn more about filters in general and how to create them in this section.
Dashboard and Report objects will both contain the object filters. This object will contain any filters that have been set up as user prompt filters, these are filters that a user can change at run time. Any hardcoded filters on a report are not able to be accessed through the API.
The filter object can be accessed as follows
| dashboard.filters.getFilter('47fe96c2-5101-4b0d-9018-7d12a84d3519'); //Will return null |