Report

Represents a report, a set of data that meets certain criteria, displayed in an organized way. Access is read-only.

Introduced in API version 20.0.

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

  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Description: The description of the report. Limit: 255 characters.

  • Type: string

  • Properties: Filter, Group, Sort

  • Introduced: API version 14.0

  • 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.

    When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record.
  • Type: string
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 35.0
  • Description: Name of the folder that contains the report.

  • Type: picklist

  • Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort

  • Introduced: API version 29.0

  • Description:

    Required. Indicates the format of the report. 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.
  • Type: datetime
  • Properties: Filter, Nillable, Sort
  • Description: Returns the date the report was last run. Label is Last Run.
  • Type: string
  • Properties: Filter, Group, idLookup, Sort
  • Description: Required. The report label used in the user interface.

  • Type: string

  • Properties: Filter, Group, Nillable, Sort

  • Introduced: API version 14.0

  • Description:

    The namespace prefix that is associated with this object. Each Developer Edition org 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 orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless 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 org of the package developer.
    • In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.

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

  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 48.0

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.

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

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

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

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.