--- schema_version: "1" id: 459e8bf5ba0c9b0a7fd27f54611eb8016255299ea91b4cb65f6c7dc952d85976 title: ReportMetadata Class collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/apexref/apex_class_reports_reportmetadata.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm source_site: developer.salesforce.com content_type: documentation content_hash: 08afeef180564727f2744d736fe9db54c2d8631664fbb772f8c9015ab0fd44f1 description: "Contains report metadata for a tabular, summary, or matrix report.Returns unique identifiers for summary or custom summary formula fields in the report.Returns a list of bucket fields in the report.Returns information about cross filters applied to a report.Returns report currency, such as USD, EUR, or GBP, for an organization that has multicurrency enabled. The value is null if the organization does not have multicurrency enabled.Returns information about custom summary formulas in a report.Returns the description of the report.Returns unique API names (column names) for the fields that contain detailed data. For example, the method might return the following values: “OPPORTUNITY_NAME, TYPE, LEAD_SOURCE, AMOUNT.”Returns the report API name. For example, the method might return the following value: “Closed_Sales_This_Quarter.”Returns the division specified in the report.Returns column groupings in a report.Returns row groupings for a report.Indicates whether the report has detail rows.Indicates whether the report shows the total number of records.Returns a list of historical snapshot dates.Returns the unique report ID.Returns the report name.Returns logic to parse custom field filters. The value is null when filter logic is not specified.Returns a list of each custom filter in the report along with the field name, filter operator, and filter value.Returns the format of the report.Returns the unique API name and display name for the report type.Returns the API name for the scope defined for the report. Scope values depend on the report type.Indicates whether the report shows the grand total.Indicates whether the report shows subtotals, such as column or row totals.Returns the list of columns on which the report is sorted. Currently, you can sort on only one column.Returns information about the standard date filter for the report, such as the start date, end date, date range, and date field API name.Returns a list of standard filters for the report.Returns information about a row limit filter, including the number of rows returned and the sort order.Sets unique identifiers for standard or custom summary formula fields in the report.Creates bucket fields in a report.Applies cross filters to a report.Sets the currency, such as USD, EUR, or GBP, for report summary fields in an organization that has multicurrency enabled.Adds a custom summary formula to a report.Sets the description of the report.Sets the unique API names for the fields that contain detailed data—for example, OPPORTUNITY_NAME, TYPE, LEAD_SOURCE, or AMOUNT.Sets the report API name—for example, Closed_Sales_This_Quarter.Sets the division of the report.Sets column groupings in a report.Sets row groupings for a report.Specifies whether the report has detail rows.Specifies whether the report is configured to show the total number of records.Sets a list of historical snapshot dates.Sets the unique report ID.Sets the report name.Sets logic to parse custom field filters.Sets a list of each custom filter in the report along with the field name, filter operator, and filter value.Sets the format of the report.Sets the unique API name and display name for the report type.Sets the API name for the scope defined for the report. Scope values depend on the report type.Specifies whether the report shows the grand total.Specifies whether the report shows subtotals, such as column or row totals.Sets the list of columns on which the report is sorted. Currently, you can only sort on one column.Sets the standard date filter—which includes the start date, end date, date range, and date field API name—for the report.Sets one or more standard filters on the report.Applies a row limit filter to a report." --- # ReportMetadata Class Contains report metadata for a tabular, summary, or matrix report. ## Namespace [Reports](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_namespace_Reports.htm "The Reports namespace provides classes for accessing the same data as is available in the Salesforce Reports and Dashboards REST API.") ## Usage Report metadata gives information about the report as a whole, such as the report type, format, summary fields, row or column groupings, and filters that are saved to the report. You can use the ReportMetadata class to retrieve report metadata and to set metadata that can be used to filter a report. ## ReportMetadata Methods The following are methods for ReportMetadata. All are instance methods. - **[getAggregates()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_Reports_ReportMetadata_getAggregates)** Returns unique identifiers for summary or custom summary formula fields in the report. - **[getBuckets()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_Reports_ReportMetadata_getBuckets)** Returns a list of bucket fields in the report. - **[getCrossFilters()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_getCrossFilters)** Returns information about cross filters applied to a report. - **[getCurrencyCode()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_Reports_ReportMetadata_getCurrencyCode)** Returns report currency, such as USD, EUR, or GBP, for an organization that has multicurrency enabled. The value is null if the organization does not have multicurrency enabled. - **[getCustomSummaryFormula()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_Reports_ReportMetadata_getCustomSummaryFomula)** Returns information about custom summary formulas in a report. - **[getDescription()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_getDescription)** Returns the description of the report. - **[getDetailColumns()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_Reports_ReportMetadata_getDetailColumns)** Returns unique API names (column names) for the fields that contain detailed data. For example, the method might return the following values: “OPPORTUNITY\_NAME, TYPE, LEAD\_SOURCE, AMOUNT.” - **[getDeveloperName()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_Reports_ReportMetadata_getDeveloperName)** Returns the report API name. For example, the method might return the following value: “Closed\_Sales\_This\_Quarter.” - **[getDivision()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_getDivision)** Returns the division specified in the report. - **[getGroupingsAcross()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_Reports_ReportMetadata_getGroupingsAcross)** Returns column groupings in a report. - **[getGroupingsDown()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_Reports_ReportMetadata_getGroupingsDown)** Returns row groupings for a report. - **[getHasDetailRows()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_getHasDetailRows)** Indicates whether the report has detail rows. - **[getHasRecordCount()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_getHasRecordCount)** Indicates whether the report shows the total number of records. - **[getHistoricalSnapshotDates()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_Reports_ReportMetadata_getHistoricalSnapshotDates)** Returns a list of historical snapshot dates. - **[getId()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_Reports_ReportMetadata_getId)** Returns the unique report ID. - **[getName()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_Reports_ReportMetadata_getName)** Returns the report name. - **[getReportBooleanFilter()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_Reports_ReportMetadata_getReportBooleanFilter)** Returns logic to parse custom field filters. The value is null when filter logic is not specified. - **[getReportFilters()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_Reports_ReportMetadata_getReportFilters)** Returns a list of each custom filter in the report along with the field name, filter operator, and filter value. - **[getReportFormat()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_Reports_ReportMetadata_getReportFormat)** Returns the format of the report. - **[getReportType()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_Reports_ReportMetadata_getReportType)** Returns the unique API name and display name for the report type. - **[getScope()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_getScope)** Returns the API name for the scope defined for the report. Scope values depend on the report type. - **[getShowGrandTotal()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_getShowGrandTotal)** Indicates whether the report shows the grand total. - **[getShowSubtotals()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_getShowSubtotals)** Indicates whether the report shows subtotals, such as column or row totals. - **[getSortBy()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_getSortBy)** Returns the list of columns on which the report is sorted. Currently, you can sort on only one column. - **[getStandardDateFilter()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_getStandardDateFilter)** Returns information about the standard date filter for the report, such as the start date, end date, date range, and date field API name. - **[getStandardFilters()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_getStandardFilters)** Returns a list of standard filters for the report. - **[getTopRows()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_getTopRows)** Returns information about a row limit filter, including the number of rows returned and the sort order. - **[setAggregates(aggregates)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_setAggregates)** Sets unique identifiers for standard or custom summary formula fields in the report. - **[setBuckets(buckets)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_Reports_ReportMetadata_setBuckets)** Creates bucket fields in a report. - **[setCrossFilters(crossFilters)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_setCrossFilters)** Applies cross filters to a report. - **[setCurrencyCode(currencyCode)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_setCurrencyCode)** Sets the currency, such as USD, EUR, or GBP, for report summary fields in an organization that has multicurrency enabled. - **[setCustomSummaryFormula(customSummaryFormula)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_Reports_ReportMetadata_setCustomSummaryFormula)** Adds a custom summary formula to a report. - **[setDescription(description)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_setDescription)** Sets the description of the report. - **[setDetailColumns(detailColumns)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_setDetailColumns)** Sets the unique API names for the fields that contain detailed data—for example, OPPORTUNITY\_NAME, TYPE, LEAD\_SOURCE, or AMOUNT. - **[setDeveloperName(developerName)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_setDeveloperName)** Sets the report API name—for example, Closed\_Sales\_This\_Quarter. - **[setDivision(division)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_setDivision)** Sets the division of the report. - **[setGroupingsAcross(groupingInfo)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_setGroupingsAcross)** Sets column groupings in a report. - **[setGroupingsDown(groupingInfo)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_setGroupingsDown)** Sets row groupings for a report. - **[setHasDetailRows(hasDetailRows)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_setHasDetailRows)** Specifies whether the report has detail rows. - **[setHasRecordCount(hasRecordCount)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_setHasRecordCount)** Specifies whether the report is configured to show the total number of records. - **[setHistoricalSnapshotDates(historicalSnapshot)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_Reports_ReportMetadata_setHistoricalSnapshotDates)** Sets a list of historical snapshot dates. - **[setId(id)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_setId)** Sets the unique report ID. - **[setName(name)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_setName)** Sets the report name. - **[setReportBooleanFilter(reportBooleanFilter)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_Reports_ReportMetadata_setReportBooleanFilter)** Sets logic to parse custom field filters. - **[setReportFilters(reportFilters)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_Reports_ReportMetadata_setReportFilters)** Sets a list of each custom filter in the report along with the field name, filter operator, and filter value. - **[setReportFormat(format)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_setReportFormat_2)** Sets the format of the report. - **[setReportType(reportType)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_setReportType)** Sets the unique API name and display name for the report type. - **[setScope(scopeName)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_setScope)** Sets the API name for the scope defined for the report. Scope values depend on the report type. - **[setShowGrandTotal(showGrandTotal)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_setShowGrandTotal)** Specifies whether the report shows the grand total. - **[setShowSubtotals(showSubtotals)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_setShowSubtotals)** Specifies whether the report shows subtotals, such as column or row totals. - **[setSortBy(column)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_setSortBy)** Sets the list of columns on which the report is sorted. Currently, you can only sort on one column. - **[setStandardDateFilter(dateFilter)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_setStandardDateFilter)** Sets the standard date filter—which includes the start date, end date, date range, and date field API name—for the report. - **[setStandardFilters(filters)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_setStandardFilters)** Sets one or more standard filters on the report. - **[setTopRows(topRows)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportmetadata.htm#apex_reports_ReportMetadata_setTopRows)** Applies a row limit filter to a report. ### getAggregates() Returns unique identifiers for summary or custom summary formula fields in the report. #### Syntax public LIST getAggregates() #### Return Value Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_list.htm#apex_methods_system_list "Contains methods for the List collection type.")<[String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")\> #### Usage For example: - a!Amount represents the average for the Amount column. - s!Amount represents the sum of the Amount column. - m!Amount represents the minimum value of the Amount column. - x!Amount represents the maximum value of the Amount column. - s! represents the sum of a custom field column. For custom fields and custom report types, the identifier is a combination of the summary type and the field ID. ### getBuckets() Returns a list of bucket fields in the report. #### Signature public List getBuckets() #### Return Value Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_list.htm#apex_methods_system_list "Contains methods for the List collection type.")<[Reports.BucketField](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_BucketField.htm#apex_class_reports_BucketField "Contains methods and constructors to work with information about a bucket field, including bucket type, name, and bucketed values.")\> ### getCrossFilters() Returns information about cross filters applied to a report. #### Signature public Reports.CrossFilter getCrossFilters() #### Return Value Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_list.htm#apex_methods_system_list "Contains methods for the List collection type.")<[Reports.CrossFilter](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_CrossFilter.htm#apex_class_reports_CrossFilter "Contains methods and constructors used to work with information about a cross filter.")\> ### getCurrencyCode() Returns report currency, such as USD, EUR, or GBP, for an organization that has multicurrency enabled. The value is null if the organization does not have multicurrency enabled. #### Syntax public String getCurrencyCode() #### Return Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") ### getCustomSummaryFormula() Returns information about custom summary formulas in a report. #### Signature public Map getCustomSummaryFormula() #### Return Value Type: [Map](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_map.htm#apex_methods_system_map "Contains methods for the Map collection type.")<[String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type."),[Reports.ReportCsf](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_class_reports_ReportCsf "Contains methods and constructors for working with information about a custom summary formula (CSF).")\> ### getDescription() Returns the description of the report. #### Signature public String getDescription() #### Return Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") ### getDetailColumns() Returns unique API names (column names) for the fields that contain detailed data. For example, the method might return the following values: “OPPORTUNITY\_NAME, TYPE, LEAD\_SOURCE, AMOUNT.” #### Syntax public LIST getDetailColumns() #### Return Value Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_list.htm#apex_methods_system_list "Contains methods for the List collection type.")<[String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")\> ### getDeveloperName() Returns the report API name. For example, the method might return the following value: “Closed\_Sales\_This\_Quarter.” #### Syntax public String getDeveloperName() #### Return Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") ### getDivision() Returns the division specified in the report. ![Note](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/images/icon_note.png) #### Note Reports that use standard filters (such as My Cases or My Team’s Accounts) show records in all divisions. These reports can’t be further limited to a specific division. #### Signature public String getDivision() #### Return Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") ### getGroupingsAcross() Returns column groupings in a report. #### Syntax public LIST getGroupingsAcross() #### Return Value Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_list.htm#apex_methods_system_list "Contains methods for the List collection type.")<[Reports.GroupingInfo](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_groupinginfo.htm#apex_class_reports_groupinginfo "Contains methods for describing fields that are used for grouping.")\> #### Usage The identifier is: - An empty array for reports in summary format, because summary reports don't include column groupings - BucketField\_(ID) for bucket fields, where ID is a placeholder value. - The ID of a custom field when the custom field is used for a column grouping ### getGroupingsDown() Returns row groupings for a report. #### Syntax public LIST getGroupingsDown() #### Return Value Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_list.htm#apex_methods_system_list "Contains methods for the List collection type.")<[Reports.GroupingInfo](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_groupinginfo.htm#apex_class_reports_groupinginfo "Contains methods for describing fields that are used for grouping.")\> #### Usage The identifier is: - BucketField\_(ID) for bucket fields, where ID is a placeholder value. - The ID of a custom field when the custom field is used for grouping ### getHasDetailRows() Indicates whether the report has detail rows. #### Signature public Boolean getHasDetailRows() #### Return Value Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_boolean.htm#apex_methods_system_boolean "Contains methods for the Boolean primitive data type.") ### getHasRecordCount() Indicates whether the report shows the total number of records. #### Signature public Boolean getHasRecordCount() #### Return Value Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_boolean.htm#apex_methods_system_boolean "Contains methods for the Boolean primitive data type.") ### getHistoricalSnapshotDates() Returns a list of historical snapshot dates. #### Syntax public LIST getHistoricalSnapshotDates() #### Return Value Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_list.htm#apex_methods_system_list "Contains methods for the List collection type.")<[String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")\> ### getId() Returns the unique report ID. #### Syntax public Id getId() #### Return Value Type: [Id](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_id.htm#apex_methods_system_id "Contains methods for the ID primitive data type.") ### getName() Returns the report name. #### Syntax public String getName() #### Return Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") ### getReportBooleanFilter() Returns logic to parse custom field filters. The value is null when filter logic is not specified. #### Syntax public String getReportBooleanFilter() #### Return Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") ### getReportFilters() Returns a list of each custom filter in the report along with the field name, filter operator, and filter value. #### Syntax public LIST getReportFilters() #### Return Value Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_list.htm#apex_methods_system_list "Contains methods for the List collection type.")<[Reports.ReportFilter](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportfilter.htm#apex_class_reports_reportfilter "Contains information about a report filter, including column, operator, and value.")\> ### getReportFormat() Returns the format of the report. #### Syntax public Reports.ReportFormat getReportFormat() #### Return Value Type: [Reports.ReportFormat](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_enum_reports_reportformat.htm "Contains the possible report format types.") #### Usage This value can be: - TABULAR - SUMMARY - MATRIX ### getReportType() Returns the unique API name and display name for the report type. #### Syntax public Reports.ReportType getReportType() #### Return Value Type: [Reports.ReportType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reporttype.htm#apex_class_reports_reporttype "Contains the unique API name and display name for the report type.") ### getScope() Returns the API name for the scope defined for the report. Scope values depend on the report type. #### Signature public String getScope() #### Return Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") ### getShowGrandTotal() Indicates whether the report shows the grand total. #### Signature public Boolean getShowGrandTotal() #### Return Value Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_boolean.htm#apex_methods_system_boolean "Contains methods for the Boolean primitive data type.") ### getShowSubtotals() Indicates whether the report shows subtotals, such as column or row totals. #### Signature public Boolean getShowSubtotals() #### Return Value Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_boolean.htm#apex_methods_system_boolean "Contains methods for the Boolean primitive data type.") ### getSortBy() Returns the list of columns on which the report is sorted. Currently, you can sort on only one column. #### Signature public List getSortBy() #### Return Value Type: List<[Reports.SortColumn](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_SortColumn.htm#apex_class_reports_SortColumn "Contains information about the sort column used in the report.")\> ### getStandardDateFilter() Returns information about the standard date filter for the report, such as the start date, end date, date range, and date field API name. #### Signature public Reports.StandardDateFilter getStandardDateFilter() #### Return Value Type: [Reports.StandardDateFilter](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_StandardDateFilter.htm#apex_class_reports_StandardDateFilter "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.") ### getStandardFilters() Returns a list of standard filters for the report. #### Signature public List getStandardFilters() #### Return Value Type: List<[Reports.StandardFilter](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_StandardFilter.htm#apex_class_reports_StandardFilter "Contains information about the standard filter defined in the report, such as the filter field API name and filter value.")\> ### getTopRows() Returns information about a row limit filter, including the number of rows returned and the sort order. #### Signature public Reports.TopRows getTopRows() #### Return Value Type: [Reports.TopRows](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_TopRows.htm#apex_class_reports_TopRows "Contains methods and constructors for working with information about a row limit filter.") ### setAggregates(aggregates) Sets unique identifiers for standard or custom summary formula fields in the report. #### Signature public void setAggregates(List aggregates) #### Parameters - **aggregates**: Type: List<[String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")\> #### Return Value Type: void ### setBuckets(buckets) Creates bucket fields in a report. #### Signature public void setBuckets(List buckets) #### Parameters - **buckets**: Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_list.htm#apex_methods_system_list "Contains methods for the List collection type.")<[Reports.BucketField](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_BucketField.htm#apex_class_reports_BucketField "Contains methods and constructors to work with information about a bucket field, including bucket type, name, and bucketed values.")\> #### Return Value Type: void ### setCrossFilters(crossFilters) Applies cross filters to a report. #### Signature public void setCrossFilters(List crossFilters) #### Parameters - **crossFilter**: Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_list.htm#apex_methods_system_list "Contains methods for the List collection type.")<[Reports.CrossFilter](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_CrossFilter.htm#apex_class_reports_CrossFilter "Contains methods and constructors used to work with information about a cross filter.")\> #### Return Value Type: void ### setCurrencyCode(currencyCode) Sets the currency, such as USD, EUR, or GBP, for report summary fields in an organization that has multicurrency enabled. #### Signature public void setCurrencyCode(String currencyCode) #### Parameters - **currencyCode**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") #### Return Value Type: void ### setCustomSummaryFormula(customSummaryFormula) Adds a custom summary formula to a report. #### Signature public void setCustomSummaryFormula(MAP customSummaryFormula) #### Parameters - **customSummaryFormula**: Type: [Map](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_map.htm#apex_methods_system_map "Contains methods for the Map collection type.")<[String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type."), [Reports.ReportCsf](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_class_reports_ReportCsf "Contains methods and constructors for working with information about a custom summary formula (CSF).")\> #### Return Value Type: void ### setDescription(description) Sets the description of the report. #### Signature public void setDescription(String description) #### Parameters - **description**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") #### Return Value Type: void ### setDetailColumns(detailColumns) Sets the unique API names for the fields that contain detailed data—for example, OPPORTUNITY\_NAME, TYPE, LEAD\_SOURCE, or AMOUNT. #### Signature public void setDetailColumns(List detailColumns) #### Parameters - **detailColumns**: Type: List<[String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")\> #### Return Value Type: void ### setDeveloperName(developerName) Sets the report API name—for example, Closed\_Sales\_This\_Quarter. #### Signature public void setDeveloperName(String developerName) #### Parameters - **developerName**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") #### Return Value Type: void ### setDivision(division) Sets the division of the report. ![Note](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/images/icon_note.png) #### Note Reports that use standard filters (such as My Cases or My Team’s Accounts) show records in all divisions. These reports can’t be further limited to a specific division. #### Signature public void setDivision(String division) #### Parameters - **division**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") #### Return Value Type: void ### setGroupingsAcross(groupingInfo) Sets column groupings in a report. #### Signature public void setGroupingsAcross(List groupingInfo) #### Parameters - **groupingInfo**: Type: List<[Reports.GroupingInfo](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_groupinginfo.htm#apex_class_reports_groupinginfo "Contains methods for describing fields that are used for grouping.")\> #### Return Value Type: void ### setGroupingsDown(groupingInfo) Sets row groupings for a report. #### Signature public void setGroupingsDown(List groupingInfo) #### Parameters - **groupingInfo**: Type: List<[Reports.GroupingInfo](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_groupinginfo.htm#apex_class_reports_groupinginfo "Contains methods for describing fields that are used for grouping.")\> #### Return Value Type: void ### setHasDetailRows(hasDetailRows) Specifies whether the report has detail rows. #### Signature public void setHasDetailRows(Boolean hasDetailRows) #### Parameters - **hasDetailRows**: Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_boolean.htm#apex_methods_system_boolean "Contains methods for the Boolean primitive data type.") #### Return Value Type: void ### setHasRecordCount(hasRecordCount) Specifies whether the report is configured to show the total number of records. #### Signature public void setHasRecordCount(Boolean hasRecordCount) #### Parameters - **hasRecordCount**: Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_boolean.htm#apex_methods_system_boolean "Contains methods for the Boolean primitive data type.") #### Return Value Type: void ### setHistoricalSnapshotDates(historicalSnapshot) Sets a list of historical snapshot dates. #### Syntax public Void setHistoricalSnapshotDates(LIST historicalSnapshot) #### Parameters - **historicalSnapshot**: Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_list.htm#apex_methods_system_list "Contains methods for the List collection type.")<[String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")\> #### Return Value Type: Void ### setId(id) Sets the unique report ID. #### Signature public void setId(Id id) #### Parameters - **id**: Type: [Id](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_id.htm#apex_methods_system_id "Contains methods for the ID primitive data type.") #### Return Value Type: void ### setName(name) Sets the report name. #### Signature public void setName(String name) #### Parameters - **name**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") #### Return Value Type: void ### setReportBooleanFilter(reportBooleanFilter) Sets logic to parse custom field filters. #### Syntax public Void setReportBooleanFilter(String reportBooleanFilter) #### Parameters - **reportBooleanFilter**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") #### Return Value Type: Void ### setReportFilters(reportFilters) Sets a list of each custom filter in the report along with the field name, filter operator, and filter value. #### Syntax public Void setReportFilters(LIST reportFilters) #### Parameters - **reportFilters**: Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_list.htm#apex_methods_system_list "Contains methods for the List collection type.")<[Reports.ReportFilter](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reportfilter.htm#apex_class_reports_reportfilter "Contains information about a report filter, including column, operator, and value.")\> #### Return Value Type: Void ### setReportFormat(format) Sets the format of the report. #### Signature public void setReportFormat(Reports.ReportFormat format) #### Parameters - **format**: Type: [Reports.ReportFormat](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_enum_reports_reportformat.htm#apex_enum_reports_reportformat "Contains the possible report format types.") #### Return Value Type: void ### setReportType(reportType) Sets the unique API name and display name for the report type. #### Signature public void setReportType(Reports.ReportType reportType) #### Parameters - **reportType**: Type: [Reports.ReportType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_reporttype.htm#apex_class_reports_reporttype "Contains the unique API name and display name for the report type.") #### Return Value Type: void ### setScope(scopeName) Sets the API name for the scope defined for the report. Scope values depend on the report type. #### Signature public void setScope(String scopeName) #### Parameters - **scopeName**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") #### Return Value Type: void ### setShowGrandTotal(showGrandTotal) Specifies whether the report shows the grand total. #### Signature public void setShowGrandTotal(Boolean showGrandTotal) #### Parameters - **showGrandTotal**: Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_boolean.htm#apex_methods_system_boolean "Contains methods for the Boolean primitive data type.") #### Return Value Type: void ### setShowSubtotals(showSubtotals) Specifies whether the report shows subtotals, such as column or row totals. #### Signature public void setShowSubtotals(Boolean showSubtotals) #### Parameters - **showSubtotals**: Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_boolean.htm#apex_methods_system_boolean "Contains methods for the Boolean primitive data type.") #### Return Value Type: void ### setSortBy(column) Sets the list of columns on which the report is sorted. Currently, you can only sort on one column. #### Signature public void setSortBy(List column) #### Parameters - **column**: Type: List<[Reports.SortColumn](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_SortColumn.htm#apex_class_reports_SortColumn "Contains information about the sort column used in the report.")\> #### Return Value Type: void ### setStandardDateFilter(dateFilter) Sets the standard date filter—which includes the start date, end date, date range, and date field API name—for the report. #### Signature public void setStandardDateFilter(Reports.StandardDateFilter dateFilter) #### Parameters - **dateFilter**: Type: [Reports.StandardDateFilter](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_StandardDateFilter.htm#apex_class_reports_StandardDateFilter "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.") #### Return Value Type: void ### setStandardFilters(filters) Sets one or more standard filters on the report. #### Signature public void setStandardFilters(List filters) #### Parameters - **filters**: Type: List<[Reports.StandardFilter](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_StandardFilter.htm#apex_class_reports_StandardFilter "Contains information about the standard filter defined in the report, such as the filter field API name and filter value.")\> #### Return Value Type: void ### setTopRows(topRows) Applies a row limit filter to a report. #### Signature public Reports.TopRows setTopRows(Reports.TopRows topRows) #### Parameters - **topRows**: Type: [Reports.TopRows](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_TopRows.htm#apex_class_reports_TopRows "Contains methods and constructors for working with information about a row limit filter.") #### Return Value Type: void