Search Response
Search Response
All information regarding the processed search query is available in the search response. The search response is available in JSON format for new search API and Search Servlet. You can also get the search response in XML for Search Servlet
New Search API JSON Response
{
"start" : 1,
"hits" : 218,
"end" : 1,
"facets" : [ {
"facet" : [ {
"count" : 1,
"name" : "keywords",
"int" : [ {
"from" : null,
"count" : 2,
"to" : null,
"name" : "world news",
"filter" : false
} ]
} ]
},
"sortDir" : "desc",
"suggest" : "",
"tuning" : {
"clickWeight" : "10",
"tuneKey" : "2",
"tuneURL" : "5",
"tuneDoc" : "180",
"tuneDesc" : "3",
"tune" : true,
"tuneTitle" : "5",
"tuneURLWeight" : "10",
"tune.0" : "5",
"tune.1" : "3",
"tune.2" : "2",
"tune.3" : "5",
"tune.4" : "180",
"tune.5" : "10",
"tune.6" : "10"
},
"lastPage" : 218,
"highlight" : true,
"enddate" : "",
"sort" : "relevance",
"startdate" : "",
"ads" : [ ],
"currentPage" : 1,
"query" : "world",
"result" : [ {
"col" : "6",
"creationdate" : "2020-07-15T13:07:01.249Z",
"twitter:card" : "summary_large_image",
"og:site_name" : "CNN",
"keywords" : "world news, international news, world news today",
"description" : "View CNN <highlight>world</highlight> news today for international news and videos from Europe, Asia, Africa, the Middle East and the Americas.",
"click_count" : 1.0,
"section" : "world",
"language" : "en",
"vr:canonical" : "https://edition.cnn.com/world",
"title" : "<highlight>World</highlight> news – breaking news, videos and headlines - CNN",
"sb_boost" : 1.0,
"og:description" : "View CNN world news today for international news and videos from Europe, Asia, Africa, the Middle East and the Americas.",
"document_allow" : [ "unsecured" ],
"og:pubdate" : "2014-02-18T16:43:26Z",
"uid" : "e961bce18e0be2c3a020e51d05b4a152",
"colname" : "atest",
"alpha" : "World news – breaking news, videos ",
"sortdate" : "2020-07-15T13:07:01.071Z",
"lastmod" : "2020-07-07T10:01:53Z",
"pubdate" : "2014-02-18T16:43:26Z",
"twitter:title" : "World news – breaking news, videos and headlines - CNN",
"og:type" : "website",
"indexdate" : "2020-07-15T13:07:01.249Z",
"urllen" : 29.0,
"og:title" : "World news – breaking news, videos and headlines - CNN",
"fb:pages" : "5550296508,18793419640",
"url" : "https://edition.cnn.com/world",
"contenttype" : "HTML",
"referrer" : "unsafe-url",
"fb:app_id" : "80401312489",
"filename" : "",
"size" : "1347832",
"viewport" : "widthdevice-width, initial-scale1.0, minimum-scale1.0",
"old_uid" : "https://edition.cnn.com/world",
"twitter:description" : "View CNN world news today for international news and videos from Europe, Asia, Africa, the Middle East and the Americas.",
"lastmodified" : "2020-07-15T13:07:01.071Z",
"og:url" : "https://www.cnn.com/world",
"crawldate" : "2020-07-15T13:06:55.162Z",
"es_metadata_id" : "e961bce18e0be2c3a020e51d05b4a152",
"context" : "<highlight>World</highlight> news – breaking news, videos and headlines - CNN <highlight>World</highlight> Africa Americas Asia Australia China Europe India Middle East United Kingdom Edition U.S. International Arabic Español Search CNN Open...Menu Africa Americas Asia Australia China Europe India Middle East United Kingdom Search Edition U.S. International Arabic Español <highlight>World</highlight> Africa Americas Asia Australia China Europe India Middle East...Shows A-Z CNNVR Features Call to Earth Freedom Project Impact Your <highlight>World</highlight> Inside Africa 2 Degrees CNN Heroes All Features More Photos Longform Investigations CNN Profiles CNN Leadership CNN Newsletters...",
"no" : "1"
} ],
"filter" : "",
"time" : 23.0
}
Attributes for New Search API Response
- This table lists the attributes in general search response for New Search API
| Attribute | Description |
|---|---|
| start | The hit or match number of the first search result on this page. |
| hits | The number of hits or matches for the query. |
| end | The hit or match number of the last search result on this page. |
| facets | The facets enabled in the search URL. The list of facets will be available in the response based on the facet. field parameter provided in the search API URL. |
| facet.count | facet field size specified in the URL. |
| facet.name | Name of the facet field. |
| facet.int.from | from attribute specific to the date and a numeric field. |
| facet.int.count | The count on the number of results with the specific value. |
| facet.int.to | to attribute specific to the date and numeric field |
| facet.int.name | The value for the facet. |
| facet.int.filter | This attribute will be true if the value of the facet is specified in the facet filter attribute in the URL. |
| sortdir | Indicates whether the search results are sorted in ascending or descending order. The possible values for this attribute are asc and desc. |
| suggest | Spelling suggestions, if available. |
| tuning | Tuning related parameters. |
| tuning.clickweight | Descriptive Tuning parameter value for click count. |
| tuning.tuneKey | Descriptive tuning parameter value for Keywords. |
| tuning.tuneURL | Descriptive tuning parameter value for URL. |
| tuning.tuneDoc | Descriptive tuning parameter value for Lastmodified date. |
| tuning.tuneDesc | Descriptive tuning parameter value for Description |
| tuning.tune | Tuning parameter value will be true when tuning is enabled and false otherwise. |
| tuning.tuneTitle | Descriptive tuning parameter value for Title. |
| tuning.tuneURLWeight | Descriptive tuning parameter value for the length of URL. |
| tune.0 | Tuning parameter value for Title |
| tune.1 | Tuning parameter value for Description. |
| tune.2 | Tuning parameter value for Keywords. |
| tune.3 | Tuning parameter value for URL. |
| tune.4 | Tuning parameter value for lastmodified date. |
| tune.5 | Tuning parameter value for URL length. |
| tune.6 | Tuning parameter value for click count. |
| lastPage | This indicates the last possible page number for this set of search results. |
| highlight | When the highlight option is enabled in search settings the value would be true, otherwise, it would be false. |
| enddate | Indicates the end date for the date range search. |
| sort | Indicates how the search results are sorted. The possible values for this attribute are relevance, date, and alpha. |
| startdate | Indicates the start date for the date range search. |
| ads | Featured results for the search query |
| currentPage | This indicates the current page number for this set of search results. |
| query | The search query. |
| result | The results element with multiple search results. The attributes of this element are listed in the next table. |
| filter | Preset filter used for the query. |
| time | Time is taken to return the results of the search query in seconds. |
| pagesize | The number of search results per page. |
- This table lists the general attributes within each search result for New Search API
- These are the general fields.
- There will also be custom fields that will be indexed based on the meta tags and collection type indexed.
| Element / Attribute | Description |
|---|---|
| no | The order number of the search result. |
| url | Search result document URL. |
| lastmodified | Last modified date of the document. |
| indexdate | Date the document was indexed. |
| creationdate | Date the document was created. |
| title | Title of the document. |
| alpha | The text for the search result that is used for alphabetical sorting. |
| keywords | The keywords contained in the document. |
| contenttype | The format of the document. |
| context | This is the fragment of the content where the search query appears. This is available only when the documents have been indexed with the Keyword-In-Context feature enabled. |
| description | The description contained in the document. |
| click_count | Count value which gets incremented based on clicking/viewing of corresponding search result. |
| language | Language setting for the document. |
| score | The relevance score for the document for this query. |
| highlight | Indicates terms that have been highlighted. |
| size | Document size in bytes. |
| urllen | The length of the url. |
| col | Collection number. |
| colname | Collection name. |
| filename | Name of file indexed. |
Search Servlet JSON Response
{
"results": {
"@hits": "265",
"@time": "12.00",
"@query": "world",
"@suggest": "",
"@filter": "",
"@sort": "relevance",
"@sortdir": "desc",
"@start": "1",
"@end": "1",
"@currentpage": "1",
"@lastpage": "265",
"@startdate": "0",
"@enddate": "0",
"@pagesize": "1",
"@xsl": "json",
"result": {
"@no": "1",
"@id": "e961bce18e0be2c3a020e51d05b4a152",
"score": "100",
"raw_score": "238.80423",
"title": " <highlight>World</highlight> news – breaking news, videos and headlines - CNN",
"context": {"text": " <highlight>World</highlight> news – breaking news, videos and headlines - CNN <highlight>World</highlight> Africa Americas Asia Australia China Europe India Middle East United Kingdom Edition U.S. International Arabic Español Search CNN Open...Menu Africa Americas Asia Australia China Europe India Middle East United Kingdom Search Edition U.S. International Arabic Español <highlight>World</highlight> Africa Americas Asia Australia China Europe India Middle East...Shows A-Z CNNVR Features Call to Earth Freedom Project Impact Your <highlight>World</highlight> Inside Africa 2 Degrees CNN Heroes All Features More Photos Longform Investigations CNN Profiles CNN Leadership CNN Newsletters..."},
"col": "6",
"creationdate": "15 Jul 2020 13:07:01 UTC",
"twitter-card": "summary_large_image",
"og-site_name": "CNN",
"keywords": "world news, international news, world news today",
"description": "View CNN world news today for international news and videos from Europe, Asia, Africa, the Middle East and the Americas.",
"click_count": "1.0",
"section": "world",
"language": "en",
"vr-canonical": "https://edition.cnn.com/world",
"sb_boost": "1.0",
"og-description": "View CNN world news today for international news and videos from Europe, Asia, Africa, the Middle East and the Americas.",
"document_allow": "[unsecured]",
"og-pubdate": "2014-02-18T16:43:26Z",
"uid": "e961bce18e0be2c3a020e51d05b4a152",
"colname": "atest",
"alpha": "World news – breaking news, videos ",
"lastmod": "2020-07-07T10:01:53Z",
"pubdate": "2014-02-18T16:43:26Z",
"twitter-title": "World news – breaking news, videos and headlines - CNN",
"og-type": "website",
"indexdate": "15 Jul 2020 13:07:01 UTC",
"urllen": "29.0",
"og-title": "World news – breaking news, videos and headlines - CNN",
"fb-pages": "5550296508,18793419640",
"url": "https://edition.cnn.com/world",
"contenttype": "HTML",
"referrer": "unsafe-url",
"fb-app_id": "80401312489",
"filename": [],
"size": "1347832",
"viewport": "widthdevice-width, initial-scale1.0, minimum-scale1.0",
"old_uid": "https://edition.cnn.com/world",
"twitter-description": "View CNN world news today for international news and videos from Europe, Asia, Africa, the Middle East and the Americas.",
"lastmodified": "15 Jul 2020 13:07:01 UTC",
"og-url": "https://www.cnn.com/world",
"crawldate": "2020-07-15T13:06:55.162Z",
"es_metadata_id": "e961bce18e0be2c3a020e51d05b4a152"
}
},
"relevance": {
"@tune.0": "5",
"@tune.1": "3",
"@tune.2": "2",
"@tune.3": "5",
"@tune.4": "180",
"@tune.5": "10",
"@tune.6": "10"
},
"download04xs": {"@download_url": "http://schwab.searchblox.com/searchblox/servlet/SearchServlet?pretty=true&adsDisplay=true&query=world&tune.4=180&tune.5=10&tune.2=2&sort=relevance&tune.3=5&tune.0=5&tune.1=3&tune=true&predictSearch=false&xsl=json&predictResultSize=3&default=AND&relatedQuery=false&topQuery=false&tune.6=10&pagesize=1&page=1&sortdir=desc&adsCount=3&downloadAsZipAlone=true"},
"links": {
"@url": "../servlet/SearchServlet?query=world&filter=&sort=relevance&sortdir=desc&pagesize=1&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&xsl=json&default=AND&page=",
"link": [
{
"@page": "1",
"@url": "../servlet/SearchServlet?query=world&filter=&sort=relevance&sortdir=desc&pagesize=1&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&xsl=json&default=AND&page=1"
},
{
"@page": "2",
"@url": "../servlet/SearchServlet?query=world&filter=&sort=relevance&sortdir=desc&pagesize=1&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&xsl=json&default=AND&page=2"
},
{
"@page": "3",
"@url": "../servlet/SearchServlet?query=world&filter=&sort=relevance&sortdir=desc&pagesize=1&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&xsl=json&default=AND&page=3"
},
{
"@page": "4",
"@url": "../servlet/SearchServlet?query=world&filter=&sort=relevance&sortdir=desc&pagesize=1&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&xsl=json&default=AND&page=4"
},
{
"@page": "5",
"@url": "../servlet/SearchServlet?query=world&filter=&sort=relevance&sortdir=desc&pagesize=1&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&xsl=json&default=AND&page=5"
},
{
"@page": "6",
"@url": "../servlet/SearchServlet?query=world&filter=&sort=relevance&sortdir=desc&pagesize=1&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&xsl=json&default=AND&page=6"
},
{
"@page": "7",
"@url": "../servlet/SearchServlet?query=world&filter=&sort=relevance&sortdir=desc&pagesize=1&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&xsl=json&default=AND&page=7"
},
{
"@page": "8",
"@url": "../servlet/SearchServlet?query=world&filter=&sort=relevance&sortdir=desc&pagesize=1&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&xsl=json&default=AND&page=8"
},
{
"@page": "9",
"@url": "../servlet/SearchServlet?query=world&filter=&sort=relevance&sortdir=desc&pagesize=1&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&xsl=json&default=AND&page=9"
},
{
"@page": "10",
"@url": "../servlet/SearchServlet?query=world&filter=&sort=relevance&sortdir=desc&pagesize=1&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&xsl=json&default=AND&page=10"
},
{
"@page": "next",
"@url": "../servlet/SearchServlet?query=world&filter=&sort=relevance&sortdir=desc&pagesize=1&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&xsl=json&default=AND&page=2"
},
{
"@page": "date",
"@url": "../servlet/SearchServlet?query=world&filter=&sort=date&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&page=1&pagesize=1&xsl=json"
},
{
"@page": "alpha",
"@url": "../servlet/SearchServlet?query=world&filter=&sort=alpha&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&page=1&pagesize=1&xsl=json"
},
{
"@page": "relevance",
"@url": "../servlet/SearchServlet?query=world&filter=&sort=relevance&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&page=1&pagesize=1&xsl=json"
}
]
},
"facets": [],
"searchform": {
"@url": "../servlet/SearchServlet",
"@query": "world",
"collections": [
{
"@id": "1",
"@name": "HTTPCollection",
"@checked": "true"
},
{
"@id": "6",
"@name": "atest",
"@checked": "true"
},
{
"@id": "3",
"@name": "dbs",
"@checked": "true"
},
{
"@id": "4",
"@name": "developer",
"@checked": "true"
},
{
"@id": "2",
"@name": "test",
"@checked": "true"
},
{
"@id": "5",
"@name": "test1",
"@checked": "true"
}
]
}
}
Search Servlet XML Response
<searchdoc>
<results hits="292" time="12.00" query="world" suggest="" filter="" sort="relevance" sortdir="desc" start="1" end="1" currentpage="1" lastpage="292" startdate="0" enddate="0" pagesize="1" xsl="xml">
<result no="1" id="e961bce18e0be2c3a020e51d05b4a152">
<score>99</score>
<raw_score>254.77159</raw_score>
<title>
<highlight>World</highlight>
<text> news – breaking news, videos and headlines - CNN</text>
</title>
<context>
<highlight>World</highlight>
<text> news – breaking news, videos and headlines - CNN </text>
<highlight>World</highlight>
<text> Africa Americas Asia Australia China Europe India Middle East United Kingdom Edition U.S. International Arabic Español Search CNN Open</text>
<text>...</text>
<text>Menu Africa Americas Asia Australia China Europe India Middle East United Kingdom Search Edition U.S. International Arabic Español </text>
<highlight>World</highlight>
<text> Africa Americas Asia Australia China Europe India Middle East</text>
<text>...</text>
<text>Shows A-Z CNNVR Features Call to Earth Freedom Project Impact Your </text>
<highlight>World</highlight>
<text> Inside Africa 2 Degrees CNN Heroes All Features More Photos Longform Investigations CNN Profiles CNN Leadership CNN Newsletters</text>
<text>...</text>
</context>
<col>6</col>
<creationdate>15 Jul 2020 13:07:01 UTC</creationdate>
<twitter-card>summary_large_image</twitter-card>
<og-site_name>CNN</og-site_name>
<keywords>world news, international news, world news today</keywords>
<description>View CNN world news today for international news and videos from Europe, Asia, Africa, the Middle East and the Americas.</description>
<click_count>1.0</click_count>
<section>world</section>
<language>en</language>
<vr-canonical>https://edition.cnn.com/world</vr-canonical>
<sb_boost>1.0</sb_boost>
<og-description>View CNN world news today for international news and videos from Europe, Asia, Africa, the Middle East and the Americas.</og-description>
<document_allow>[unsecured]</document_allow>
<og-pubdate>2014-02-18T16:43:26Z</og-pubdate>
<uid>e961bce18e0be2c3a020e51d05b4a152</uid>
<colname>atest</colname>
<alpha>World news – breaking news, videos </alpha>
<lastmod>2020-07-07T10:01:53Z</lastmod>
<pubdate>2014-02-18T16:43:26Z</pubdate>
<twitter-title>World news – breaking news, videos and headlines - CNN</twitter-title>
<og-type>website</og-type>
<indexdate>15 Jul 2020 13:07:01 UTC</indexdate>
<urllen>29.0</urllen>
<og-title>World news – breaking news, videos and headlines - CNN</og-title>
<fb-pages>5550296508,18793419640</fb-pages>
<url>https://edition.cnn.com/world</url>
<contenttype>HTML</contenttype>
<referrer>unsafe-url</referrer>
<fb-app_id>80401312489</fb-app_id>
<filename/>
<size>1347832</size>
<viewport>widthdevice-width, initial-scale1.0, minimum-scale1.0</viewport>
<old_uid>https://edition.cnn.com/world</old_uid>
<twitter-description>View CNN world news today for international news and videos from Europe, Asia, Africa, the Middle East and the Americas.</twitter-description>
<lastmodified>15 Jul 2020 13:07:01 UTC</lastmodified>
<og-url>https://www.cnn.com/world</og-url>
<crawldate>2020-07-15T13:06:55.162Z</crawldate>
<es_metadata_id>e961bce18e0be2c3a020e51d05b4a152</es_metadata_id>
</result>
</results>
<relevance tune.0="5" tune.1="3" tune.2="2" tune.3="5" tune.4="180" tune.5="10" tune.6="10"/>
<download04xs download_url="http://schwab.searchblox.com/searchblox/servlet/SearchServlet?pretty=true&adsDisplay=true&query=world&tune.4=180&tune.5=10&tune.2=2&sort=relevance&tune.3=5&tune.0=5&tune.1=3&tune=true&predictSearch=false&xsl=xml&predictResultSize=3&default=AND&relatedQuery=false&topQuery=false&tune.6=10&pagesize=1&page=1&sortdir=desc&adsCount=3&downloadAsZipAlone=true"/>
<links url="../servlet/SearchServlet?query=world&filter=&sort=relevance&sortdir=desc&pagesize=1&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&xsl=xml&default=AND&page=">
<link page="1" url="../servlet/SearchServlet?query=world&filter=&sort=relevance&sortdir=desc&pagesize=1&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&xsl=xml&default=AND&page=1"/>
<link page="2" url="../servlet/SearchServlet?query=world&filter=&sort=relevance&sortdir=desc&pagesize=1&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&xsl=xml&default=AND&page=2"/>
<link page="3" url="../servlet/SearchServlet?query=world&filter=&sort=relevance&sortdir=desc&pagesize=1&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&xsl=xml&default=AND&page=3"/>
<link page="4" url="../servlet/SearchServlet?query=world&filter=&sort=relevance&sortdir=desc&pagesize=1&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&xsl=xml&default=AND&page=4"/>
<link page="5" url="../servlet/SearchServlet?query=world&filter=&sort=relevance&sortdir=desc&pagesize=1&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&xsl=xml&default=AND&page=5"/>
<link page="6" url="../servlet/SearchServlet?query=world&filter=&sort=relevance&sortdir=desc&pagesize=1&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&xsl=xml&default=AND&page=6"/>
<link page="7" url="../servlet/SearchServlet?query=world&filter=&sort=relevance&sortdir=desc&pagesize=1&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&xsl=xml&default=AND&page=7"/>
<link page="8" url="../servlet/SearchServlet?query=world&filter=&sort=relevance&sortdir=desc&pagesize=1&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&xsl=xml&default=AND&page=8"/>
<link page="9" url="../servlet/SearchServlet?query=world&filter=&sort=relevance&sortdir=desc&pagesize=1&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&xsl=xml&default=AND&page=9"/>
<link page="10" url="../servlet/SearchServlet?query=world&filter=&sort=relevance&sortdir=desc&pagesize=1&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&xsl=xml&default=AND&page=10"/>
<link page="next" url="../servlet/SearchServlet?query=world&filter=&sort=relevance&sortdir=desc&pagesize=1&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&xsl=xml&default=AND&page=2"/>
<link page="date" url="../servlet/SearchServlet?query=world&filter=&sort=date&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&page=1&pagesize=1&xsl=xml"/>
<link page="alpha" url="../servlet/SearchServlet?query=world&filter=&sort=alpha&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&page=1&pagesize=1&xsl=xml"/>
<link page="relevance" url="../servlet/SearchServlet?query=world&filter=&sort=relevance&col=1&col=6&col=3&col=4&col=2&col=5&startdate=0&enddate=0&page=1&pagesize=1&xsl=xml"/>
</links>
<facets/>
<searchform url="../servlet/SearchServlet" query="world">
<collections>
<collection id="1" name="HTTPCollection" checked="true"/>
<collection id="6" name="atest" checked="true"/>
<collection id="3" name="dbs" checked="true"/>
<collection id="4" name="developer" checked="true"/>
<collection id="2" name="test" checked="true"/>
<collection id="5" name="test1" checked="true"/>
</collections>
</searchform>
</searchdoc>
Attributes for Search Servlet Response
- This table lists the attributes in general search response for Search Servlet
| Attribute | Description |
|---|---|
| hits | Number of hits or matches for the query. |
| time | Time is taken to return the results of the search query in seconds. |
| query | The search query. |
| suggest | Spelling suggestions, if available. |
| filter | Preset filter used for the query. |
| sort | Indicates how the search results are sorted. The possible values for this attribute are relevance, date, and alpha. |
| sortdir | Indicates whether the search results are sorted in ascending or descending order. The possible values for this attribute are asc and desc. |
| start | The hit or match number of the first search result on this page. |
| end | The hit or match number of the last search result on this page. |
| currentpage | This indicates the current page number for this set of search results. |
| lastpage | This indicates the last possible page number for this set of search results. |
| startdate | Indicates the start date for the date range search. |
| enddate | Indicates the end date for the date range search. |
| pagesize | Number of search results per page. |
| xsl | The template in which the search results appear. |
| result | The result element with multiple search results. The attributes of this element are listed in the next table. |
| relevance.tune.0 | Tuning parameter value for Title. |
| relevance.tune.1 | Tuning parameter value for Description. |
| relevance.tune.2 | Tuning parameter value for Keywords. |
| relevance.tune.3 | Tuning parameter value for URL. |
| relevance.tune.4 | Tuning parameter value for lastmodified date. |
| relevance.tune.5 | Tuning parameter value for URL length. |
| relevance.tune.6 | Tuning parameter value for click count. |
| facets.@name | Name of the facet field. |
| facets.@count | Facet field size specified in the URL. |
| facets.int.@name | The value for the facet. |
| facets.int.@filter | This attribute will be true if the value of the facet is specified in the facet filter attribute in URL. |
| facets.int.#text | The count on the number of results with the specific value. |
| facets.int.from | from attribute specific to the date and a numeric field. |
| facets.int.to | to attribute specific to the date and a numeric field. |
| links | The element contains pre-canned page URLs to simplify the process of paginating through the search results. The page URLs available here include links to specific page numbers, the next and previous pages to the current page, and the URLs for the alternative sorting options. |
| searchform | The element provides all the information to display the search form as part of the search results. |
| searchform.@url | Search Servlet reference for collection based search. |
| searchform.@query | Search query. |
| searchform.collections.@id | Collection number. |
| searchform.collections.@name | Collection name. |
| searchform.collections.@checked | If the collection is selected or provided in URL parameter the value will be true otherwise false. |
- This table lists the attributes within each search result for Search Servlet
- These are the general fields.
- There will also be custom fields that will be indexed based on the meta tags and collection type indexed
| Element / Attribute | Description |
|---|---|
| no | The order number of the search result. |
| url | Search result document URL. |
| lastmodified | Last modified date of document. |
| indexdate | Date the document was indexed. |
| creationdate | Date the document was created. |
| title | Title of the document. |
| alpha | The text for the search result that is used for alphabetical sorting. |
| keywords | The keywords contained in the document. |
| contenttype | The format of the document. |
| context | This is the fragment of the content where the search query appears. This is available only when the documents have been indexed with the Keyword-In-Context feature enabled. |
| description | The description contained in the document. |
| click_count | Count value which gets incremented based on clicking/viewing of corresponding search result. |
| language | Language setting for the document. |
| score | The relevance score for the document for this query. |
| highlight | Indicates terms that have been highlighted. |
| size | Document size in bytes. |
| urllen | The length of the url. |
| col | Collection Number. |
| colname | Collection name. |
| filename | Name of file indexed. |
General Information
- Facet filters display results count JSON/XML.
- View results in JSON or XML in a parametrized search to view the relevant response.* When
using Advanced Search use parameters specific to the same.
Updated over 4 years ago