---
schema_version: "1"
id: 35164e638b6f16e209172bef25e2707532fa0c289004eb9e9b5578b6015c59b1
title: FileSearchActivity
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_filesearchactivity.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_filesearchactivity.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 1d481a7f820197fd4d3aa1cc11053bf0daf6b6351728a111cd0a4dc656212807
description: Represents search activity on a file. This object is available in API version 38.0 and later.
---
# 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.



 |