Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/webhood-io/webhood/llms.txt

Use this file to discover all available pages before exploring further.

Webhood’s search page uses the PocketBase filter syntax to query the scans collection. The search bar includes an autocomplete that suggests common field names and operators as you type, making it easy to build precise queries without memorising the full syntax. Once you run a query, the filter expression is embedded in the page URL so you can bookmark or share it with colleagues.

​
Filter syntax basics

Filters are boolean expressions. Each clause compares a field to a value using an operator.

​
Text match (contains)

url ~ "phishing.example"
The ~ operator performs a case-insensitive substring match. This is the most common operator for searching URLs.

​
Exact match

status = "done"

​
Negation

status != "error"

​
Date comparison

created >= "2024-01-01"

created <= "2024-12-31"
Dates are compared as ISO 8601 strings. You can use >=, <=, >, and <.

​
Combining expressions

Use && (AND) to require multiple conditions: 
url ~ "login" && status = "done"
Use || (OR) to match any of several conditions: 
status = "error" || status = "pending"

​
Searchable fields

FieldTypeDescription
urlstringThe URL that was submitted for scanning.
final_urlstringThe URL the browser ended up on after redirects.
statusstringScan lifecycle state: pending, queued, running, done, or error.
slugstringThe unique short identifier used in the scan result URL.
createddatetimeWhen the scan record was created.
updateddatetimeWhen the scan record was last updated.

​
Practical examples

All completed scans 
status = "done"
Scans involving a specific domain 
url ~ "example.com"
Scans that failed 
status = "error"
Scans created on or after 1 June 2024 
created >= "2024-06-01"
Completed scans whose submitted URL contains “login” 
url ~ "login" && status = "done"
Scans where the final URL differs from the submitted domain (redirect to a different site) 
url ~ "example.com" && final_url != "https://example.com"
Scans from a date range 
created >= "2024-01-01" && created <= "2024-06-30"

​
Shareable queries

Every time you run a search, Webhood updates the browser URL to include the filter expression as a query parameter: 
/search?filter=url+~+"phishing.example"&page=1
Copy the URL from your browser’s address bar to share the exact query with a team member. They will see the same results when they open the link (subject to any changes in the database since you ran the query).
The autocomplete in the search bar suggests the most common field names (url, status, created, etc.) and operators (=, ~, !=, >=, <=). Start typing a field name or operator to see suggestions. Pressing Enter or clicking Search runs the query; a ✔ indicator confirms the query syntax is valid before you submit.
For the complete filter syntax reference — including nested relation filters and more advanced operators — see the PocketBase filter syntax documentation.

Build docs developers (and LLMs) love

Get started for freeTalk to us