Get quick search results in a list format
GET {{baseUrl}}/api/searches/results?type=776&limit=100
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 |
name
|
string | Value the search pattern is set to, which will be applied to the names of object types being searched. For example, search for all report objects (type) whose name begins with (pattern) B (name). | |
pattern
|
number | Pattern to search for, such as Begin With or Exactly. Possible values are defined in [EnumDSSXMLSearchTypes](https://lw.microstrategy.com/msdz/msdl/GARelease_Current/docs/ReferenceFiles/reference/com/microstrategy/webapi/EnumDSSXMLSearchTypes.html). 2 is for "Exactly". | |
type
|
number | Type of object to be searched, such as Folder, Attribute or User. Possible values are defined in [EnumDSSObjectType](https://lw.microstrategy.com/msdz/msdl/GARelease_Current/docs/ReferenceFiles/reference/com/microstrategy/webapi/EnumDSSXMLObjectTypes.html). To specify multiple types in API explorer, simply specify them with newline delimiter. 776 is for cube object type | |
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. | |
projectId
|
null | Project IDs where the search will be performed. X-MSTR-ProjectID will be ignored and isCrossCluster will be regarded as true if the project IDs are specified. | |
limit
|
number | Maximum number of items returned for a single request. Use -1 for no limit. | |
Curl curl -X GET 'baseUrl/api/searches/results?type=776&limit=100?name=Subcategory&pattern=2&type=776&viewMedia=&projectId=&limit=100&root=publicObjectsFolderId&getAncestors=false&offset=0&certifiedStatus=ALL&isCrossCluster=false&fields=' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' ENDPOINTS |