Response Fields
This section describes the response fields returned by web search.
| XML header fields | |
|---|---|
| Field name | Description |
| count | Indicates how many results to show per page. The value shown in results is the smaller of the default or explicit “count” request argument value or the actual number of results in the response. The result set will include the requested “count” unless there are fewer than that number of matching documents. |
| start | The first numeric result to display. The value shown in results echoes the default or explicit “start” request argument value. When used with ”count”, you can display follow-on pages of results. |
| totalhits | A result count that reflects no duplicates. The totalhits value is
an approximation, and its value may change depending on the requested “start” and
“count” values, because the approximation is adjusted as more exact result URLs are
processed. A normal use for totalhits is to determine how many pages of
results to offer in search result navigation. Since totalhits is an
approximation, and the value may change as “start” increases on successive result pages,
the result page navigation may need to be adjusted as a user browses result
pages.
|
| deephits | It returns an approximate count that reflects duplicate documents and all
documents from a host. deephits, therefore, is invariably equal to or
larger than TotalHits. The deephits value is normally used as
an information display on a search result page, reporting how many total documents
matched the search terms.
|
| abstract | Abstract with keywords highlighted with HTML tags. abstract=long
will retrieve and display an abstract of a web document up to 300 characters. This
expanded abstract provides the requester with a larger piece of information to work from
in a web search query.
|
| title | Title with keywords highlighted with HTML tags |
| url | URL of result |
| clickurl | Returns a navigation URL that leads to the target URL for each result. A
clickurl might lead through a redirect server, which provides Yahoo! with
important usage data from search result sets. See coding requirement (url
vs clickurl) in overview
|
| dispurl | Returns the URLs of documents matching the query result. Use this field only for
display purposes on result pages. To direct search users to the target document, use the
clickurl value
|
| size | Returns the document’s size in bytes |
| date | Returns date in YYYY/MM/DD format |
| keyterms | When view=keyterms is used in query string the keyterms
section is included in the response. This includes a list of related words and phrases
with the <term> subheadings.
|
| searchmonkey_feed | Using this field will retrieve structured data markup, if available, for the search result in dataRSS format. |
| searchmonkey_rdf | Using this field will retrieve structured data markup, if available, for the search result in RDF format. |
| delicious_toptags | Retrieves the top public delicious tags for a document and the counts associated with each tag. |
| delicious_saves | The number of times a document was saved in delicious. |
| language | The language of the document. |