extension shown: health [x]

SearchAction

Thing > Action > SearchAction

The act of searching for an object.

Related actions:

.

Usage: Over 1,000,000 domains
[more...]
PropertyExpected TypeDescription
Properties from SearchAction
query Text A sub property of instrument. The query used on this action.
Properties from Action
actionStatus ActionStatusType Indicates the current disposition of the Action.
agent Person  or
Organization 
The direct performer or driver of the action (animate or inanimate). e.g. *John* wrote a book.
endTime 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.
error Thing For failed actions, more information on the cause of the failure.
instrument Thing The object that helped the agent perform the action. e.g. John wrote a book with *a pen*.
location PostalAddress  or
Place 
The location of the event, organization or action.
object 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*.
participant Person  or
Organization 
Other co-agents that participated in the action indirectly. e.g. John wrote a book with *Steve*.
result Thing The result produced in the action. e.g. John wrote *a book*.
startTime 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.
target EntryPoint Indicates a target EntryPoint for an Action.
Properties from Thing
additionalType 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.
alternateName Text An alias for the item.
description Text A short description of the item.
image ImageObject  or
URL 
An image of the item. This can be a URL or a fully described ImageObject.
mainEntityOfPage CreativeWork  or
URL 
Indicates a page (or other CreativeWork) for which this thing is the main entity being described.

See background notes for details.
Inverse property: mainEntity.
name Text The name of the item.
potentialAction Action Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
sameAs 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.
url URL URL of the item.


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>

Schema Version 2.1