Search Response

All details about the processed search query are included in the search response, which is provided in JSON format for both the new Search API and the 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 main attributes included in the general search response for the New Search API.

Attribute	Description
start	Shows the number of the first result on the page.
hits	Total number of matching results for the search.
end	Shows the number of the last result on the page.
facets	Lists the facet filters used in the search URL, based on the facet.field parameter.
facet.count	Number of facet values returned (as set in the URL).
facet.name	Name of the facet field.
facet.int.from	The starting value for a date or number range.
facet.int.count	Number of results that match that specific value or range.
facet.int.to	The ending value for a date or number range.
facet.int.name	The actual facet value displayed.
facet.int.filter	Shows true if that facet value was applied as a filter.
sortdir	Sorting order of results: asc (ascending) or desc (descending).
suggest	Shows spelling suggestion if available.
tuning	Shows relevancy tuning information.
tuning.clickweight	Descriptive tuning value for click count.
tuning.tuneKey	Descriptive tuning value for keywords.
tuning.tuneURL	Descriptive tuning value for URL.
tuning.tuneDoc	Descriptive tuning value for lastmodified date.
tuning.tuneDesc	Descriptive tuning value for description.
tuning.tune	True if tuning is ON, false if OFF.
tuning.tuneTitle	Descriptive tuning value for title.
tuning.tuneURLWeight	Descriptive tuning value for URL length.
tune.0	Tuning value for title.
tune.1	Tuning value for description.
tune.2	Tuning value for keywords.
tune.3	Tuning value for URL.
tune.4	Tuning value for lastmodified date.
tune.5	Tuning value for URL length.
tune.6	Tuning value for click count.
lastPage	Last page number for the results.
highlight	True if highlighting is ON, false if OFF.
enddate	End date used in date range search.
sort	Sorting type: relevance, date, or alpha.
startdate	Start date used in date range search.
ads	Featured results for the query.
currentPage	The page number you are currently on.
query	The search text you entered.
result	Contains all search results (details shown in next table).
filter	Any preset filter used.
time	Time taken to show results (in seconds).
pagesize	Number of results shown per page.

This table lists the basic details included with each search result in the New Search API.
These are the common fields that appear for all results.
Additional custom fields may also appear depending on the meta tags and the type of collection you indexed.

Element / Attribute	Description
no	The position number of the search result.
url	The link to the document in the search result.
lastmodified	The date when the document was last updated.
indexdate	The date when the document was added to the search index.
creationdate	The date when the document was originally created.
title	The name or title of the document.
alpha	Text used for sorting results alphabetically.
keywords	Words or tags found inside the document.
contenttype	The file type or format of the document.
context	A small preview showing where the searched words appear in the document (shown only if Keyword-In-Context is enabled).
description	A short description from the document.
click_count	The number of times this search result has been clicked or viewed.
language	The language used in the document.
score	How relevant the document is to the search query.
highlight	Shows the words that are highlighted in the search result.
size	The file size of the document (in bytes).
urllen	The total number of characters in the URL.
col	Collection number.
colname	Collection name.
filename	Name of file indexed.