Searching your data

• Words in a title, description, or alias.
• Tags.
• Creator.
• Collection.
• ID or alias.
• Structured metadata.

• Keyword search for a quick text query with optional filters.
• Structured search for combining multiple conditions with AND, OR, and NOT.

• Search only returns assets you can access.
• Starred assets appear first, followed by the newest matches.

​

Choose what you’re searching

• Assets — your data records (the default; everything below in this tutorial).
• Collections — your folder-like containers.
• Projects — your top-level workspaces.
• People — researchers, by name.
• Publications — scholarly works.
• Grants — funding awards.

​

Set up

​

1. Keyword search

1. From anywhere in the signed-in app, open the search modal: click the centered Search pill in the top bar, or press Cmd/Ctrl + K.
2. Type a term in the input (placeholder “Type something or select saved queries”). A category dropdown lists the clause kinds: Text/Keywords, Collection, ID/Alias, Tags, Creator, Metadata.
3. Pick Text/Keywords to commit your term as a chip, then press Enter (or click the purple Search button).
4. You land on the /search results page: the header reads New search query (with a Save query action), the filter bar shows the active expression, the count line reads “Searching…” then “N files”, and the results table lists matching assets with infinite-scroll paging.

# Simple keyword search (the `s` Session from setup is already logged in).
r = s.get(f"{API}/api/search/", params={"q": "pyroelectric", "limit": 5})
r.raise_for_status()
hits = r.json()                                   # bare list, not {"results": [...]}
print(len(hits), "hits | more pages?", r.headers.get("X-Has-More"))
for a in hits:
    print(" -", a["title"], "| tags:", a["tags"], "| creator:", a["creator_name"])

next_cursor = r.headers.get("X-Next-Cursor")      # pass back as ?cursor= for page 2

r = s.get(f"{API}/api/search/", params={
    "q": "demo",
    "tags": "sdk,demo",                  # comma-separated, AND logic, exact tag match
    "creator": "tutorial",               # name OR email, substring match
    "metadata": ["measurements.depth"],  # bare key -> key existence
    "limit": 5,
})
r.raise_for_status()
print(len(r.json()), "faceted hits | more?", r.headers.get("X-Has-More"))

​

2. Structured search across categories

• {"text": "<str>"} — substring across title/description/alias
• {"collection": "<uuid>"}, {"id": "<uuid-or-alias>"}, {"tag": "<str>"}, {"creator": "<name-or-email>"}
• metadata operators: {"eq": {"path": v}}, {"ne": ...}, {"gt"|"gte"|"lt"|"lte": {"path": num}}, {"exists": "path"}, {"not_exists": "path"}, {"contains": {"path": "str"}}, {"contains_keywords": {"path": "str"}}, {"array_contains"|"array_not_contains": {"path": v}}

1. Open the search modal (Search in the top bar, or Cmd/Ctrl + K) and start typing.
2. Pick a clause kind from the dropdown. For Metadata, a 3-step picker runs: choose a data type (Numerical / String / Boolean / Array, under the header “Chose data type”), then an operator (“Chose operator” — e.g. Equal, Greater than, Contains, Exists), then enter a value. For Collection, a collection-tree picker opens.
3. Combine clauses: click Add Boolean Group (AND/OR/NOT) to add a row, and use the join chips between clauses to switch AND / OR / NOT. The bar shows a plain-language summary of the expression.
4. Click the Search submit button. You land on the search results page with your expression preserved in the browser URL.

import json

# Faceted boolean query across MULTIPLE categories:
#   (text "pyroelectric" OR tag "sdk")  AND  metadata depth >= 10  AND  NOT tag "archived"
query = {
    "and": [
        {"or": [{"text": "pyroelectric"}, {"tag": "sdk"}]},
        {"gte": {"measurements.depth": 10}},
        {"not": {"tag": "archived"}},
    ]
}
r = s.post(f"{API}/api/assets/query/",
           params={"limit": 50},
           json={"query": query, "tags": ["demo"]})   # `tags` here is a pre-filter (AND)
r.raise_for_status()
assets = r.json()                                       # bare list of Asset objects
print(len(assets), "hits | more?", r.headers.get("X-Has-More"),
      "| post-filtered?", r.headers.get("X-Post-Filter"))
print(json.dumps([a["title"] for a in assets], indent=2))

​

3. Advanced (graph) search

​

Next steps

• Permissions & sharing
• Public access