Report

Represents a report, a set of data that meets certain criteria, displayed in an organized way. Access is read-only. This object is available in API version 20.0 and later.

Supported Calls

describeSObjects(), query(), retrieve(), search()

Fields

Field Details
Description
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The description of the report. Limit: 255 characters.
DeveloperName
Type
string
Properties
Filter, Group, Sort
Description
Required. The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is Report Unique Name.
Note

Note

When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record.

FolderName
Type
string
Properties
Filter, Nillable, Sort
Description
Name of the folder that contains the report. Available in API version 35.0 and later.
Format
Type
picklist
Properties
Defaulted on create, Filter, Group, Sort
Description
Required. Indicates the format of the report. This field is available in API version 29.0 and later. Can have one of these values:
  • Tabular for reports in that format. In the application, the label is Tabular.
  • Summary for reports in that format. In the application, the label is Summary.
  • Matrix for reports in that format. In the application, the label is Matrix.
  • Multiblock for reports in joined format. In the application, the label is Joined.
IsDeleted
Type
boolean
Properties
Defaulted on create, Filter
Description
Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
LastReferencedDate
Type
date
Properties
Filter, Nillable, Sort, Update
Description
The timestamp for when the current user last viewed a record related to this record.
LastRunDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Returns the date the report was last run. Label is Last Run.
LastViewedDate
Type
date
Properties
Filter, Nillable, Sort, Update
Description
The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
Name
Type
string
Properties
Filter, Group, Sort
Description
Required. The report label used in the user interface.
NamespacePrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.

The namespace prefix can have one of the following values:

  • In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer.
  • In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects.

This field can’t be accessed unless the logged-in user has the “Customize Application” permission.

OwnerId
Type
reference
Properties
Filter
Description
The ID of the user who currently owns this report.

Supported Query Scopes

Use these scopes to help specify the data your SOQL query returns.

allPrivate
Records saved in all users’ private folders.

Requires the user permission "Manage All Private Reports and Dashboards" and Enhanced Analytics Folder Sharing. If your organziation was created after the Summer ’13 release, you already have Enhanced Analytics Folder Sharing. Available in API version 36.0 and later.

created
Records created by the user running the query.
everything
All records except records saved in other users’ private folders.
mine
Records saved in the private folder of the user running the query.
organizationOwned
Records saved in Unfiled Public Reports. In Lightning Experience, the Unfiled Public Reports folder is called Public Reports.

Usage

Use the report object to get report metadata. Query, search, or retrieve specific metadata on reports. Report object fields are read-only.

Example: Reports with “Sales” in Their Name

This SOQL query returns reports that contain the name “Sales” and lists their developer names, format, ID, and report name.

SELECT DeveloperName,Format,Id,Name FROM Report WHERE Name LIKE '%Sales%'

Example: Reports in an Inactive User’s Private Folder

This SOQL query returns reports saved in a specific user’s private folder.

SELECT Id FROM Report USING SCOPE allPrivate WHERE OwnerId = ‘005A0000000Bc2deFG’

See Also