Filters

Filters records are used to save the setup of your views, reports and widgets across Productive.

Attributes

chart_type_id integer
Response Request Parameter `filter`

ID of the chart visualization type used when displaying this filter as a report chart.

columns string
Response Request

An ordered list of column identifiers defining which columns are visible in this filter's list view.

column_settings string
Response Request

A JSON object containing per-column display settings such as width and visibility.

created_at string
Response Parameter `filter` Parameter `sort`

Timestamp when this filter was created.

creator person
Response Parameter `sort`

The person who created this filter.

creator_id integer
Parameter `filter`

ID of the person who created this filter.

default object
Response

Whether this filter is the default view loaded when navigating to the associated resource list.

exchange_currency string
Response Request

The currency used for exchange rate conversions when this filter displays monetary values.

exchange_date object
Response Request

A JSON object defining the date or date range used for currency exchange rate lookups in this filter.

export_params object
Response Request

A JSON object containing additional parameters used when exporting data from this filter.

filterable_collection string
Response Request Parameter `filter` Parameter `sort`

The collection of resources (e.g. tasks, bookings) that this filter applies to.

filterable_id integer
Response Request Parameter `filter`

ID of the specific resource (e.g. a project) this filter is scoped to, or null for organization-wide filters.

filterable_type string
Response Request Parameter `filter`

The type of resource this filter is scoped to (e.g. projects), or null for organization-wide filters.

formulas string
Response Request

Custom formula definitions used to compute derived values in report-type filters.

group_by string
Response Request

The field identifier used to group results in this filter's view.

hidden boolean
Response Request

Whether this filter is hidden from the navigation sidebar.

id string
Parameter `filter`

The unique identifier of this filter, expressed as a slug combining the numeric ID, filterable type, and collection.

last_accessed_at string
Parameter `filter` Parameter `sort`

Timestamp when this filter was last accessed by any user.

last_pulse_sent_at string
Response Parameter `filter` Parameter `sort`

Timestamp when the last pulse notification was sent for this filter.

last_viewed_at string
Response Parameter `filter` Parameter `sort`

Timestamp when this filter was last viewed by the current user.

layout_id integer
Response Request

ID of the layout mode used to display this filter (e.g. list, board, timeline).

memberships array of membership
Response

People or teams who have been granted access to this shared filter.

name string
Response Request Parameter `filter` Parameter `sort`

The display name of this filter.

organization organization
Response

The organization this filter belongs to.

original_id integer
Response

The internal numeric ID of this filter, as opposed to the slug-based id field.

params string
Response Request

A hash of filter criteria (field/value pairs) that define what records this filter matches.

predefined_id string
Response Request

The identifier of the predefined system filter this was created from, if applicable.

project_id integer
Parameter `filter`

ID of the project this filter is scoped to, when filterable_type is projects.

public boolean
Response Request

Whether this filter is visible to all members of the organization.

pulse boolean
Parameter `filter`

The pulse notification associated with this filter, if any.

pulse_count object
Response

The number of unread pulse notifications for the current user on this report filter.

query string
Parameter `filter`

A text search query applied as an additional keyword filter when loading results.

report boolean
Response Request Parameter `filter`

Indicates whether this saved filter is of report type.

report_category report category
Response

The report category this filter belongs to.

report_category_id integer
Request Parameter `filter` Parameter `sort`

ID of the report category this filter belongs to.

report_layout_id integer
Response Request Parameter `filter`

ID of the report layout used by this filter.

settings string
Response Request

A JSON object containing miscellaneous UI settings for this filter, such as collapsed state or display preferences.

shared boolean
Response Parameter `filter`

Whether this filter has been shared with specific people or teams via memberships.

sort_by string
Response Request

The field identifier used to sort results in this filter's view.

transpose_by string
Response Request

The field identifier used to pivot or transpose data in report-type filters.

type_id integer
Response Request Parameter `filter` Enum

ID of the filter type, indicating whether this is a saved view, a report, or a widget.

Enum Values (3 values)

  • 1
    View
  • 2
    Report
  • 3
    Widget
updated_at string
Response Parameter `filter` Parameter `sort`

Timestamp when this filter was last updated.