Help everyone explore and learn from data—no SQL required.
Business intelligence for everyone
Share insights with anyone, anywhere
Create seamless in-product analytics
Open-source analytics in 5 minutes
Data tools for growing teams
Data-driven decision-making at scale
to see how to set up and publish a dashboard
Guides on working with data
News, updates and ideas
Real companies, real data, real stories
Share and connect with other users
Practical advice from our community
API endpoints for Search.
Search within a bunch of models for the substring q.
For the list of models, check `metabase.search.config/all-models.
To search in archived portions of models, pass in archived=true.
If you want, while searching tables, only tables of a certain DB id,
pass in a DB id value to table_db_id.
To specify a list of models, pass in an array to models.
q value may be nil, or if non-nil, value must be a non-blank string.
archived value may be nil, or if non-nil, value must be a valid boolean string (‘true’ or ‘false’).
table_db_id value may be nil, or if non-nil, value must be an integer greater than zero.
models value may be nil, or if non-nil, value must satisfy one of the following requirements: 1) value must be an array. Each value must be a non-blank string. 2) value must be a non-blank string.
Get the set of models that a search query will return.
« Back to API index
Did this article help you?
Thanks for your feedback!