Skip Navigation

Newer Version Available

This content describes an older version of this product. View Latest

FileSearchActivity

Represents search activity on a file. This object is available in API version 38.0 and later.

Supported Calls

describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Fields

Field	Details
AvgNumResults	Type double Properties Filter, Sort Description The number of search results returned for the search term. If Period is also included, this value is aggregated based on the time period specified.
ClickRank	Type double Properties Filter, Nillable, Sort Description The order that the file appeared in the search results when users clicked it from the list of results.
CountQueries	Type int Properties Filter, Group, Sort Description The number of searches for the period (day, month, or year).
CountUsers	Type int Properties Filter, Group, Sort Description The number of individual users who clicked the file.
Name	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of search activity.
Period	Type picklist Properties Filter, Group, Restricted picklist, Sort Description The time period that the search count is applied to. For example, a record where the Count is 70 and the Period is Monthly indicates that 70 searches took place over the past month. Totals are aggregated daily for the current month, monthly from the past full month through the past full year, and yearly beyond that. Possible values are: `DAY` `MONTH` `YEAR`
QueryDate	Type date Properties Filter, Group, Sort Description The date of the search.
QueryLanguage	Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language filter that’s applied to the user’s search.
SearchTerm	Type string Properties Filter, Group, Sort Description The first 100 characters of the search term that was used to search published files.