Version 4.0.25.20 (latest)
Get information about the dashboard filters with a specific id.
Request
GET
/dashboard_filters/{dashboard_filter_id}
Datatype
Description
Request
HTTP Request
path
HTTP Path
Expand HTTP Path definition...
dashboard_filter_id
string
Id of dashboard filters
query
HTTP Query
Expand HTTP Query definition...
fields
string
Requested fields.
Response
200: Dashboard Filter
Datatype
Description
(object)
can
lock
object
Operations the current user is able to perform on this object
id
lock
string
Unique Id
dashboard_id
lock
string
Id of Dashboard
name
string
Name of filter
title
string
Title of filter
type
string
Type of filter: one of date, number, string, or field
default_value
string
Default value of filter
model
string
Model of filter (required if type = field)
explore
string
Explore of filter (required if type = field)
dimension
string
Dimension of filter (required if type = field)
field
lock
object
Field information
row
integer
Display order of this filter relative to other filters
listens_to_filters
string[]
allow_multiple_values
boolean
Whether the filter allows multiple filter values (deprecated in the latest version of dashboards)
required
boolean
Whether the filter requires a value to run the dashboard
ui_config
object
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
string
Error details
documentation_url
lock
string
Documentation link
404: Not Found
Datatype
Description
(object)
message
lock
string
Error details
documentation_url
lock
string
Documentation link
429: Too Many Requests
Datatype
Description
(object)
message
lock
string
Error details
documentation_url
lock
string
Documentation link
