Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
Report
Supported Calls
describeSObjects(), query(), retrieve(), search()
Fields
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 organization 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.
1SELECT 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.
1SELECT Id FROM Report USING SCOPE allPrivate WHERE OwnerId = ‘005A0000000Bc2deFG’Associated Objects
This object has the following associated objects. Unless noted, they are available in the same API version as this object.
- ReportFeed
- Feed tracking is available for the object.