schema.org/SearchActionNo rich result
SearchAction schema
A site's own search capability, expressed as a URL template a consumer can fill in.
Where to use it
Nested inside WebSite, once.
A complete example
Valid as written, with every required property and the recommended ones that carry real information.
search-action.json
{
"@context": "https://schema.org",
"@type": "SearchAction",
"target": {
"@type": "EntryPoint",
"urlTemplate": "https://www.seoforsolos.com/search?q={search_term_string}"
},
"query-input": "required name=search_term_string"
}Properties
| Property | Status |
|---|---|
target | Required |
query-input | Required |
The three mistakes this type attracts
- 01Declaring it for a search route that does not exist.
- 02A urlTemplate whose parameter name does not match query-input.
- 03Adding it to every page rather than to the WebSite node.
Related types
Where this appears in the playbook
- Structured data: what each type is for and which ones earned their place.
- The schema graph: composing types into one graph with stable identifiers.
- One JSON-LD script per page, holding one @graph
- Stable @id anchors that cross-reference rather than duplicate
- Optional fields are omitted, never emitted as empty strings
Questions
What is the SearchAction schema type for?
A site's own search capability, expressed as a URL template a consumer can fill in. Use it on: nested inside WebSite, once.
Which SearchAction properties are required?
SearchAction requires 2 properties: target, query-input. It also recommends 0: .
Does SearchAction produce a rich result?
SearchAction does not produce a Google rich result. It is still worth shipping, because its value is entity resolution and answer extraction rather than search result presentation.
What is the most common SearchAction mistake?
The most common SearchAction mistake is: Declaring it for a search route that does not exist.