SearchServiceApplication.GetPopularQueries method

SharePoint 2013

Gets a list of frequent queries which are used for personal suggestions.

Namespace:  Microsoft.Office.Server.Search.Administration
Assembly:  Microsoft.Office.Server.Search (in Microsoft.Office.Server.Search.dll)

public PopularQueriesExportResults GetPopularQueries(
	int startQuery,
	int batchSize,
	SearchObjectOwner webOwner,
	SourceRecord source,
	DateTime timeStamp
)

Parameters

startQuery
Type: System.Int32

The number (offset) of the first query to retrieve.

batchSize
Type: System.Int32

The total number of queries to retrieve.

webOwner
Type: Microsoft.Office.Server.Search.Administration.SearchObjectOwner

The owner of the search site hierarchy.

source
Type: Microsoft.Office.Server.Search.Administration.Query.SourceRecord

The result source of the queries to retrieve.

timeStamp
Type: System.DateTime

Used to validate if the queries to be returned are current.

Return value

Type: Microsoft.Office.Server.Search.Query.PopularQueriesExportResults
The retrieved queries; NULL if the popular queries are not current. For example, if the timer job persisting the popular queries has not run.

Implements

ISearchSiteAdministrationServiceApplication.GetPopularQueries(Int32, Int32, SearchObjectOwner, SourceRecord, DateTime)
Show: