Version 4.0.25.2 (latest)
Get information about all the dashboard filters on a dashboard with a specific id.
Request
GET
/dashboards/{dashboard_id}/dashboard_filters
Datatype
Description
Request
path
Expand HTTP Path definition...
dashboard_id
Id of dashboard
query
Expand HTTP Query definition...
fields
Requested fields.
Response
200: Dashboard Filter
Datatype
Description
(array)
can
lock
Operations the current user is able to perform on this object
id
lock
Unique Id
dashboard_id
lock
Id of Dashboard
name
Name of filter
title
Title of filter
type
Type of filter: one of date, number, string, or field
default_value
Default value of filter
model
Model of filter (required if type = field)
explore
Explore of filter (required if type = field)
dimension
Dimension of filter (required if type = field)
field
lock
Field information
row
Display order of this filter relative to other filters
listens_to_filters
allow_multiple_values
Whether the filter allows multiple filter values (deprecated in the latest version of dashboards)
required
Whether the filter requires a value to run the dashboard
ui_config
The visual configuration for this filter. Used to set up how the UI for this filter should appear.
400: Bad Request
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
404: Not Found
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
429: Too Many Requests
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link