The Reports namespace provides classes for
accessing the same data as is available in the Salesforce Reports and Dashboards REST
API.
The following are the classes in the Reports namespace.
AggregateColumn Class
Contains methods for describing summary fields such as Record Count, Sum, Average, Max, Min, and custom summary formulas. Includes name, label, data type, and grouping context.
BucketField Class
Contains methods and constructors to work with information about a bucket field, including bucket type, name, and bucketed values.
BucketFieldValue Class
Contains information about the report values included in a bucket field.
ColumnDataType Enum
The Reports.ColumnDataType enum describes the type of data in a column. It is returned by the getDataType method.
ColumnSortOrder Enum
The Reports.ColumnSortOrder enum describes the order that the grouping column uses to sort data.
CrossFilter Class
Contains methods and constructors used to work with information about a cross filter.
CsfGroupType Enum
The group level at which the custom summary format aggregate is displayed in a report.
DateGranularity Enum
The Reports.DateGranularity enum describes the date interval that is used for grouping.
DetailColumn Class
Contains methods for describing fields that contain detailed data. Detailed data fields are also listed in the report metadata.
Dimension Class
Contains information for each row or column grouping.
EvaluatedCondition Class
Contains the individual components of an evaluated condition for a report notification, such as the aggregate name and label, the operator, and the value that the aggregate is compared to.
EvaluatedConditionOperator Enum
The Reports.EvaluatedConditionOperator enum describes the type of operator used to compare an aggregate to a value. It is returned by the getOperator method.
FilterOperator Class
Contains information about a filter operator, such as display name and API name.
FilterValue Class
Contains information about a filter value, such as the display name and API name.
FormulaType Enum
The format of the numbers in a custom summary formula.
GroupingColumn Class
Contains methods for describing fields that are used for column grouping.
GroupingInfo Class
Contains methods for describing fields that are used for grouping.
GroupingValue Class
Contains grouping values for a row or column, including the key, label, and value.
NotificationAction Interface
Implement this interface to trigger a custom Apex class when the conditions for a report notification are met.
NotificationActionContext Class
Contains information about the report instance and condition threshold for a report notification.
ReportCsf Class
Contains methods and constructors for working with information about a custom summary formula (CSF).
ReportCurrency Class
Contains information about a currency value, including the amount and currency code.
ReportDataCell Class
Contains the data for a cell in the report, including the display label and value.
ReportDescribeResult Class
Contains report, report type, and extended metadata for a tabular, summary, or matrix report.
ReportScopeInfo Class
Contains information about possible scope values that you can choose. Scope values depend on the report type. For example, you can set the scope for opportunity reports to All opportunities, My team’s opportunities, or My opportunities.
ReportScopeValue Class
Contains information about a possible scope value. Scope values depend on the report type. For example, you can set the scope for opportunity reports to All opportunities, My team’s opportunities, or My opportunities.
ReportType Class
Contains the unique API name and display name for the report type.
ReportTypeColumn Class
Contains detailed report type metadata about a field, including data type, display name, and filter values.
ReportTypeMetadata Class
Contains report type metadata, which gives you information about the fields that are available in each section of the report type, plus filter information for those fields.
SortColumn Class
Contains information about the sort column used in the report.
StandardDateFilter Class
Contains information about standard date filter available in the report—for example, the API name, start date, and end date of the standard date filter duration as well as the API name of the date field on which the filter is placed.
StandardDateFilterDuration Class
Contains information about each standard date filter—also referred to as a relative date filter. It contains the API name and display label of the standard date filter duration as well as the start and end dates.
StandardDateFilterDurationGroup Class
Contains information about the standard date filter groupings, such as the grouping display label and all standard date filters that fall under the grouping. Groupings include Calendar Year, Calendar Quarter, Calendar Month, Calendar Week, Fiscal Year, Fiscal Quarter, Day, and custom values based on user-defined date ranges.
StandardFilter Class
Contains information about the standard filter defined in the report, such as the filter field API name and filter value.
StandardFilterInfo Class
Is an abstract base class for an object that provides standard filter information.
StandardFilterInfoPicklist Class
Contains information about the standard filter picklist, such as the display name and type of the filter field, the default picklist value, and a list of all possible picklist values.
StandardFilterType Enum
The StandardFilterType enum describes the type of standard filters in a report. The getType() method returns a Reports.StandardFilterType enum value.