Get quick search results in a list format
GET {{baseUrl}}/api/searches/results?type=3&limit=100&name=Brand Performance by Region&pattern=2
Use the stored results of the Quick Search engine to return search results and display them as a list. The Quick Search engine periodically indexes the metadata and stores the results in memory, making Quick Search very fast but with results that may not be the most recent. You obtain the authorization token needed to execute the request using POST /auth/login; you obtain the project ID using GET /projects. You pass the authorization token and the project ID in the request header. You specify the search criteria using query parameters in the request; criteria can include the root folder ID, the type of object, whether to return ancestors of the object, a search pattern such as Begins With or Exactly, and the certified status of the object being searched for. You use the offset and limit query parameters to control paging behavior. The offset parameter specifies where to start returning search results, and the limit parameter specifies how many results to return.
Body
PARAM
| Key | Datatype | Required | Description |
root
|
string | Folder ID of the root folder where the search will be performed. | |
getAncestors
|
boolean | Specifies whether to return the list of ancestors for each object | |
offset
|
number | Starting point within the collection of returned search results. Used to control paging behavior. | |
certifiedStatus
|
string | Defines a search criteria based on the certified status of the object | |
isCrossCluster
|
boolean | Perform search in all unique projects across the cluster, this parameter only takes affect for I-Server with cluster nodes. | |
viewMedia
|
null | ViewMedia of object to be searched, such as Dossier or Document. Possible values are defined in ViewMedia. To specify multiple viewMedias in API explorer, simply specify them with newline delimiter. | |
result.hidden
|
null | Curl curl -X GET 'baseUrl/api/searches/results?type=3&limit=100&name=Brand Performance by Region&pattern=2?root=publicObjectsFolderId&getAncestors=false&offset=0&certifiedStatus=ALL&isCrossCluster=false&viewMedia=&result.hidden=&projectId=&fields=&type=3&limit=100&name=Brand Performance by Region&pattern=2' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' ENDPOINTS |