--- updatedAt: 2026-09-28T14:10:44.000Z agentTools: projectIndex: https://developer.searchblox.com/llms.txt --- # New Search API - /rest/v2/api/search?query=* JSON Payload [block:parameters] { "data": { "h-0": "JSON Fields", "h-1": "Value", "h-2": "Value", "0-0": "query", "0-1": "search query" }, "cols": 2, "rows": 1 } [/block] # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "api-settings", "version": "12.2" }, "servers": [ { "url": "https://127.0.0.1:8443/" } ], "security": [ {} ], "paths": { "/rest/v2/api/search?query=*": { "get": { "summary": "New Search API - /rest/v2/api/search?query=*", "description": "JSON Payload", "operationId": "new-search-api-restv2apisearchquery", "parameters": [ { "name": "query", "in": "query", "description": "querystring", "schema": { "type": "string", "default": "*" } }, { "name": "col", "in": "query", "description": "Collection ID", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "page", "in": "query", "description": "Page number", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "pagesize", "in": "query", "description": "Number of results per page", "schema": { "type": "integer", "format": "int64", "default": 10 } }, { "name": "sort", "in": "query", "description": "Sort options for the search results relevance", "schema": { "type": "string", "default": "relevance" } }, { "name": "sortdir", "in": "query", "description": "asc/desc", "schema": { "type": "string", "default": "asc" } }, { "name": "cname", "in": "query", "description": "Name of collection", "schema": { "type": "string", "default": "collectionName" } }, { "name": "startdate", "in": "query", "description": "Start date for date range search", "schema": { "type": "string", "format": "date-time", "default": "YYYYMMDDHHMMSS" } }, { "name": "enddate", "in": "query", "description": "End date for date range search", "schema": { "type": "string", "format": "date-time", "default": "YYYYMMDDHHMMSS" } }, { "name": "adsize", "in": "query", "description": "Number of Featured search results per page", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "default", "in": "query", "description": "Default boolean operator to be used in basic search with more than two search terms", "schema": { "type": "string", "default": "OR" } }, { "name": "XPC", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "public", "in": "query", "required": true, "schema": { "type": "string", "default": "true" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"query\": \"*\",\n \"sort\": \"relevance\",\n \"result\": [\n {\n \"col\": \"1\",\n \"twitter:card\": \"summary_large_image\",\n \"og:site_name\": \"CNN\",\n \"keywords\": \"breaking news, news online, U.S. news, world news, developing story, news video, CNN news, weather, business, money, politics, law, technology, entertainment, education, travel, health, special reports, autos, CNN TV\",\n \"description\": \"Find the latest breaking news and information on the top stories, weather, business, entertainment, politics, and more. For in-depth coverage, CNN provides special reports, video, audio, photo galleries, and interactive guides.\",\n \"section\": \"intl_homepage\",\n \"language\": \"en\",\n \"vr:canonical\": \"https://edition.cnn.com\",\n \"title\": \"CNN International - Breaking News, US News, World News and Video\",\n \"sb_boost\": 1.0,\n \"og:description\": \"Find the latest breaking news and information on the top stories, weather, business, entertainment, politics, and more. For in-depth coverage, CNN provides special reports, video, audio, photo galleries, and interactive guides.\",\n \"og:pubdate\": \"2014-02-24T14:45:54Z\",\n \"uid\": \"6ef34c2847abf2288eece34615de441a\",\n \"colname\": \"http\",\n \"alpha\": \"CNN International - Breaking News, \",\n \"sortdate\": \"2020-06-19T09:46:24.524Z\",\n \"lastmod\": \"2020-06-19T09:43:53Z\",\n \"pubdate\": \"2014-02-24T14:45:54Z\",\n \"twitter:title\": \"CNN International - Breaking News, US News, World News and Video\",\n \"og:type\": \"website\",\n \"indexdate\": \"2020-06-19T09:46:24.524Z\",\n \"urllen\": 23.0,\n \"og:title\": \"CNN International - Breaking News, US News, World News and Video\",\n \"uid_old\": \"https://edition.cnn.com\",\n \"fb:pages\": \"5550296508,18793419640\",\n \"url\": \"https://edition.cnn.com\",\n \"contenttype\": \"HTML\",\n \"referrer\": \"unsafe-url\",\n \"fb:app_id\": \"80401312489\",\n \"filename\": \"\",\n \"size\": \"1134918\",\n \"viewport\": \"widthdevice-width, initial-scale1.0, minimum-scale1.0\",\n \"lastmodified\": \"2020-06-19T09:46:24.524Z\",\n \"twitter:description\": \"Find the latest breaking news and information on the top stories, weather, business, entertainment, politics, and more. For in-depth coverage, CNN provides special reports, video, audio, photo galleries, and interactive guides.\",\n \"og:url\": \"https://edition.cnn.com\",\n \"es_metadata_id\": \"6ef34c2847abf2288eece34615de441a\",\n \"no\": \"0\"\n }\n ],\n \"filter\": \"\",\n \"time\": 15.0,\n \"start\": 1,\n \"end\": 1,\n \"facets\": [],\n \"hits\": 1,\n \"ads\": [],\n \"startdate\": \"\",\n \"enddate\": \"\",\n \"tuning\": {\n \"tuneDesc\": \"3\",\n \"tuneURL\": \"5\",\n \"tuneKey\": \"2\",\n \"tuneTitle\": \"5\",\n \"tuneDoc\": \"180\",\n \"tuneURLWeight\": \"10\",\n \"tune\": true,\n \"clickWeight\": null,\n \"tune.0\": \"5\",\n \"tune.1\": \"3\",\n \"tune.2\": \"2\",\n \"tune.3\": \"5\",\n \"tune.4\": \"180\",\n \"tune.5\": \"10\",\n \"tune.6\": \"10\"\n },\n \"lastPage\": 1,\n \"suggest\": \"\",\n \"highlight\": true,\n \"currentPage\": 1\n}" } }, "schema": { "type": "object", "properties": { "query": { "type": "string", "example": "*" }, "sort": { "type": "string", "example": "relevance" }, "result": { "type": "array", "items": { "type": "object", "properties": { "col": { "type": "string", "example": "1" }, "twitter:card": { "type": "string", "example": "summary_large_image" }, "og:site_name": { "type": "string", "example": "CNN" }, "keywords": { "type": "string", "example": "breaking news, news online, U.S. news, world news, developing story, news video, CNN news, weather, business, money, politics, law, technology, entertainment, education, travel, health, special reports, autos, CNN TV" }, "description": { "type": "string", "example": "Find the latest breaking news and information on the top stories, weather, business, entertainment, politics, and more. For in-depth coverage, CNN provides special reports, video, audio, photo galleries, and interactive guides." }, "section": { "type": "string", "example": "intl_homepage" }, "language": { "type": "string", "example": "en" }, "vr:canonical": { "type": "string", "example": "https://edition.cnn.com" }, "title": { "type": "string", "example": "CNN International - Breaking News, US News, World News and Video" }, "sb_boost": { "type": "integer", "example": 1, "default": 0 }, "og:description": { "type": "string", "example": "Find the latest breaking news and information on the top stories, weather, business, entertainment, politics, and more. For in-depth coverage, CNN provides special reports, video, audio, photo galleries, and interactive guides." }, "og:pubdate": { "type": "string", "example": "2014-02-24T14:45:54Z" }, "uid": { "type": "string", "example": "6ef34c2847abf2288eece34615de441a" }, "colname": { "type": "string", "example": "http" }, "alpha": { "type": "string", "example": "CNN International - Breaking News, " }, "sortdate": { "type": "string", "example": "2020-06-19T09:46:24.524Z" }, "lastmod": { "type": "string", "example": "2020-06-19T09:43:53Z" }, "pubdate": { "type": "string", "example": "2014-02-24T14:45:54Z" }, "twitter:title": { "type": "string", "example": "CNN International - Breaking News, US News, World News and Video" }, "og:type": { "type": "string", "example": "website" }, "indexdate": { "type": "string", "example": "2020-06-19T09:46:24.524Z" }, "urllen": { "type": "integer", "example": 23, "default": 0 }, "og:title": { "type": "string", "example": "CNN International - Breaking News, US News, World News and Video" }, "uid_old": { "type": "string", "example": "https://edition.cnn.com" }, "fb:pages": { "type": "string", "example": "5550296508,18793419640" }, "url": { "type": "string", "example": "https://edition.cnn.com" }, "contenttype": { "type": "string", "example": "HTML" }, "referrer": { "type": "string", "example": "unsafe-url" }, "fb:app_id": { "type": "string", "example": "80401312489" }, "filename": { "type": "string", "example": "" }, "size": { "type": "string", "example": "1134918" }, "viewport": { "type": "string", "example": "widthdevice-width, initial-scale1.0, minimum-scale1.0" }, "lastmodified": { "type": "string", "example": "2020-06-19T09:46:24.524Z" }, "twitter:description": { "type": "string", "example": "Find the latest breaking news and information on the top stories, weather, business, entertainment, politics, and more. For in-depth coverage, CNN provides special reports, video, audio, photo galleries, and interactive guides." }, "og:url": { "type": "string", "example": "https://edition.cnn.com" }, "es_metadata_id": { "type": "string", "example": "6ef34c2847abf2288eece34615de441a" }, "no": { "type": "string", "example": "0" } } } }, "filter": { "type": "string", "example": "" }, "time": { "type": "integer", "example": 15, "default": 0 }, "start": { "type": "integer", "example": 1, "default": 0 }, "end": { "type": "integer", "example": 1, "default": 0 }, "facets": { "type": "array", "items": { "type": "object", "properties": {} } }, "hits": { "type": "integer", "example": 1, "default": 0 }, "ads": { "type": "array", "items": { "type": "object", "properties": {} } }, "startdate": { "type": "string", "example": "" }, "enddate": { "type": "string", "example": "" }, "tuning": { "type": "object", "properties": { "tuneDesc": { "type": "string", "example": "3" }, "tuneURL": { "type": "string", "example": "5" }, "tuneKey": { "type": "string", "example": "2" }, "tuneTitle": { "type": "string", "example": "5" }, "tuneDoc": { "type": "string", "example": "180" }, "tuneURLWeight": { "type": "string", "example": "10" }, "tune": { "type": "boolean", "example": true, "default": true }, "clickWeight": {}, "tune.0": { "type": "string", "example": "5" }, "tune.1": { "type": "string", "example": "3" }, "tune.2": { "type": "string", "example": "2" }, "tune.3": { "type": "string", "example": "5" }, "tune.4": { "type": "string", "example": "180" }, "tune.5": { "type": "string", "example": "10" }, "tune.6": { "type": "string", "example": "10" } } }, "lastPage": { "type": "integer", "example": 1, "default": 0 }, "suggest": { "type": "string", "example": "" }, "highlight": { "type": "boolean", "example": true, "default": true }, "currentPage": { "type": "integer", "example": 1, "default": 0 } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```