SearchAction

schema:Thing > schema:Action > schema:SearchAction

The act of searching for an object.

Related actions:

FindAction: SearchAction generally leads to a FindAction, but not necessarily

Property	Expected Type	Description
Properties from schema:SearchAction
`schema:query`	schema:Text or schema:Class	A sub property of instrument. The query used on this action.
Properties from schema:Action
`schema:actionStatus`	schema:ActionStatusType	Indicates the current disposition of the Action.
`schema:agent`	schema:Organization or schema:Person	The direct performer or driver of the action (animate or inanimate). e.g. John wrote a book.
`schema:endTime`	schema:DateTime	The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. e.g. John wrote a book from January to December. Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
`schema:error`	schema:Thing	For failed actions, more information on the cause of the failure.
`schema:instrument`	schema:Thing	The object that helped the agent perform the action. e.g. John wrote a book with a pen.
`schema:location`	schema:Place or schema:PostalAddress	The location of the event, organization or action.
`schema:object`	schema:Thing	The object upon the action is carried out, whose state is kept intact or changed. Also known as the semantic roles patient, affected or undergoer (which change their state) or theme (which doesn't). e.g. John read a book.
`schema:participant`	schema:Organization or schema:Person	Other co-agents that participated in the action indirectly. e.g. John wrote a book with Steve.
`schema:result`	schema:Thing	The result produced in the action. e.g. John wrote a book.
`schema:startTime`	schema:DateTime	The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. e.g. John wrote a book from January to December. Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
`schema:target`	schema:EntryPoint	Indicates a target EntryPoint for an Action.
Properties from schema:Thing
`schema:additionalType`	schema:URL	An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
`schema:alternateName`	schema:Text	An alias for the item.
`schema:description`	schema:Text	A short description of the item.
`schema:image`	schema:ImageObject or schema:URL	An image of the item. This can be a URL or a fully described ImageObject.
`schema:name`	schema:Text	The name of the item.
`schema:potentialAction`	schema:Action	Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
`schema:sameAs`	schema:URL	URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Freebase page, or official website.
`schema:url`	schema:URL	URL of the item.

Prefixes used:

schema: http://schema.org/

Examples

John searched for 'What is the answer to life the universe and everything?'.

This example is JSON only.

This example is JSON only.

<script type="application/ld+json">
  // John searched for 'What is the answer to life the universe and everything?'.
{
  "@context": "http://schema.org",
  "@type": "SearchAction",
  "agent": {
    "@type": "Person",
    "name": "John"
  },
  "query": "What is the answer to life the universe and everything?"
}
</script>

John searched for hotels.

This example is JSON only.

This example is JSON only.

<script type="application/ld+json">
  // John searched for hotels.
{
  "@context": "http://schema.org",
  "@type": "SearchAction",
  "agent": {
    "@type": "Person",
    "name": "John"
  },
  "query": {
    "@type": "Class",
    "name": "http://schema.org/Hotel"
  }
}
</script>

<p>(A WebSite describing its search options)</p>

<div itemscope itemtype="http://schema.org/WebSite">
    <meta itemprop="url" content="http://www.example.com/"/>
    <form itemprop="potentialAction" itemscope itemtype="http://schema.org/SearchAction">
      <meta itemprop="target" content="http://www.example.com/search?q={query}"/>
      <input itemprop="query-input" type="text" name="query">
      <input type="submit">
    </form>
</div>

<div vocab="http://schema.org/" typeof="WebSite">
    <meta property="url" content="http://www.example.com/"/>
    <form property="potentialAction" typeof="http://schema.org/SearchAction">
      <meta property="target" content="http://www.example.com/search?q={query}"/>
      <input property="query-input" type="text" name="query">
      <input type="submit">
    </form>
</div>

<script type="application/ld+json">
{
    "@context": "http://schema.org",
    "@type": "WebSite",
    "url": "http://www.example.com/",
    "potentialAction": {
      "@type": "SearchAction",
      "target": "http://www.example.com/search?&q={query}",
      "query-input": "required"
    }
}
</script>

BiblioGraph.net Version 1.1
Schema.org Version 1.93
Code Version 1.1