Report

Represents a custom report. This metadata type only supports custom reports; standard reports aren’t supported.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Redeploying a report with the same fullName as a previously deleted report via Metadata API restores the deleted report instead of creating a new one, even if the report was removed from the Recycle Bin. The restored report keeps its original Id, CreatedDate, and CreatedById.

This type extends Metadata and inherits its fields.

Reports are stored in the reports directory of the package directory. The file name consists of the report title with the extension .report.

You can’t use the wildcard (*) symbol with reports in package.xml.

To retrieve the list of explicit report names to populate package.xml with, first call listMetadata(ListMetadataQuery[]) with a ListMetadataQuery entry with the type field set to ReportFolder and the folder field to * (wildcard). This call returns an array of FileProperties objects with the names of report folders in the fullName field.

Now call listMetadata with ListMetadataQuery entries where the type field is Report and the folder fields are the full name values from the first listMetadata call. These calls return FileProperties objects where the fullName field is the combination of the folder name and report name. Use these values in the package.xml to designate the members for the Report metadata type.

ReportFolder isn’t returned as a type in describeMetadata(). Report is returned from describeMetadata() with an associated attribute of inFolder set to true. If that attribute is set to true, you can construct the type by using the component name with the word Folder, such as ReportFolder.

The following example shows folders in package.xml:

To retrieve or deploy ReportFolders, use the Report metadata type in your package.xml. When you reference a nested folder by itself (without its contents), the API can misinterpret the path as a report component.

For example, the API interprets <members>TopLevel/SubLevel</members> as a request for a report named SubLevel.

To correctly reference the nested folder, append a trailing slash (/) to its full name. This syntax explicitly identifies the member as a folder.

Omitting the trailing slash (/) for the folder causes the operation to fail with an error: “Entity of type ‘Report’ named ‘TopLevel/SubLevel’ cannot be found”.

Introduced in API version 14.0.

  • Type: ReportAggregateFilter[]
  • Required: No
  • Introduced: API version 64.0
  • Description: List that defines filters on custom summary formulas for summary, matrix, and joined reports.
  • Type: ReportAggregate[]
  • Required: No
  • Description: List that defines custom summary formulas for summary, matrix, and joined reports.
  • Type: Report[]
  • Required: No
  • Description: Represents each block in a joined report where every block can be of a different report type.
  • Type: ReportBlockInfo
  • Required: No
  • Description: Defines attributes for each block in a joined report.
  • Type: ReportBucketField[]
  • Required: No
  • Introduced: API version 24.0
  • Description: Defines a bucket field to be used in the report.
  • Type: ReportChart
  • Required: No
  • Description: Defines a chart for summary and matrix reports.
  • Type: ReportColorRange[]
  • Required: No
  • Description: List that specifies conditional highlighting for report summary data. Salesforce Classic only.
  • Type: ReportColumn[]
  • Required: No
  • Description: List that specifies the fields displayed in the report. Fields appear in the report in the same order as they appear in the Metadata API file.
  • Type: ReportCrossFilter[]
  • Required: No
  • Description: Defines a cross filter’s object, related object, and condition (WITH or WITHOUT). This field is available in API version 68.0 and later.
  • Type: CurrencyIsoCode (enumeration of type string)
  • Required: No
  • Description: When using multiple currencies, some reports allow you to display converted amounts by selecting the appropriate column to display. For example, in opportunity reports, you can include the Amount (converted) column on the report. This field is an enumeration of type string that defines the currency in which to display converted amounts. Valid values: Must be one of the valid alphabetic, three-letter currency ISO codes defined by the ISO 4217 standard, such as USD, GBP``SLE, or JPY.
  • Type: string
  • Required: No
  • Description: Specifies a general description, which is displayed with the report name. Maximum characters: 255 characters.
  • Type: string
  • Required: No
  • Introduced: API version 17.0
  • Description: If your organization uses divisions to segment data and the Affected by Divisions permission is enabled, records in the report must match this division.

  • Type: ReportFilter

  • Required: No

  • Description: Limits report results to records with specific data. For example, you can limit report results to opportunities for which the amount is greater than $1,000:

  • Type: string
  • Required: No
  • Introduced: API version 35.0
  • Description: Name of the folder that houses the report.
  • Type: ReportFormattingRule[]
  • Required: No
  • Description: List that specifies conditional highlighting for report data. Lightning Experience only.
  • Type: ReportGrouping[]
  • Required: No
  • Description: List that defines the fields by which you want to group and subtotal data across a matrix report (row headings). When grouping by a date field, you can further group the data by a specific time period such as days, weeks, or months. Maximum: 2 fields.
  • Type: ReportGrouping[]
  • Required: No
  • Description: For Summary and Matrix reports: List that defines the fields by which you want to group and subtotal. For summary reports, choosing more than one sort field allows you to subsort your data. For matrix reports, specifies summary fields for column headings. When grouping by a date field, you can further group the data by a specific time period such as days, weeks, or months. Maximum for matrix reports: 2. Maximum for summary reports: 3

  • Type: ReportHistoricalSelector

  • Required: No

  • Description: Defines a date range for which historical trend reporting data is to be captured. Default is “Any Historical Date.”

    Available in API version 29.0 and later.

  • Type: boolean
  • Required: No
  • Introduced: API version 29.0
  • Description: false displays smart totalling on the report.
  • Type: string
  • Required: Yes
  • Description: Required. The report name. For example, Opportunity Pipeline
  • Type: int
  • Required: No
  • Introduced: API version 38.0
  • Description: Indicates whether a user has subscribed to this report Lightning Experience (1) or not (0). Tied to user context.
  • Type: ReportParam[]
  • Required: No
  • Description: List that specifies settings specific to each report type, in particular options that let you filter a report to obtain useful subsets. For example, the Activities report type lets you specify whether you want to see open or closed activities or both and whether you want to see tasks or events or both. Valid values depend on the report type.
  • Type: string
  • Required: Yes
  • Description: Required. Defines the type of data in the report. For example, Opportunity to create a report of opportunities data.
  • Type: string
  • Required: No
  • Introduced: API version 48.0
  • Description: Defines the API Name for the report type.
  • Type: string
  • Required: No
  • Introduced: API version 17.0
  • Description: The role name for a report drill down. Some reports, such as opportunity and activity reports, display Hierarchy links that allow you to drill down to different datasets based on the role hierarchy.
  • Type: int
  • Required: No
  • Description: Defines the maximum number of rows that can be returned for the report.
  • Type: string (enumeration of type string)
  • Required: No
  • Description: Defines the scope of data on which you run the report. For example, whether you want to run the report against all opportunities, opportunities you own, or opportunities your team owns. Valid values depend on the reportType. For example, for Accounts reports:
  • Possible values:
    • MyAccounts
    • MyTeamsAccounts
    • AllAccounts

  • Type: boolean

  • Required: No

  • Introduced: API version 67.0

  • Description: Indicates whether the report shows common rows only (true) or not (false). Default is false.

    Available in API version 67.0 and later

    .

  • Type: boolean
  • Required: No
  • Introduced: API version 29.0
  • Description: Can be set to true for historical trending reports in matrix format.
  • Type: boolean
  • Required: No
  • Description: false shows a collapsed view of the report with only the headings, subtotals, and total. Default: true
  • Type: boolean
  • Required: No
  • Description: true displays the calculated total for the full report.
  • Type: boolean
  • Required: No
  • Description: true displays the calculated subtotals for sections of the report.
  • Type: string
  • Required: No
  • Description: Specifies the field on which to sort data in the report. Use sortOrder to specify the sort order.
  • Type: string
  • Required: No
  • Introduced: API version 17.0
  • Description: The territory name for a report drill down. If your organization uses territory management, some reports display Hierarchy links that allow you to drill down to different datasets based on the territory hierarchy.
  • Type: ReportTimeFrameFilter
  • Required: No
  • Description: Limits report results to records within a specified time frame.
  • Type: string
  • Required: No
  • Introduced: API version 17.0
  • Description: The username for a report drill down. Some reports, such as opportunity and activity reports, display Hierarchy links that allow you to drill down to different datasets based on the user hierarchy.

An enumeration of type string that specifies the axis or axes to be used in charts.

An enumeration of type string that specifies the position of the chart in the report.

An enumeration of type string that defines the report format.

ChartSummary defines how data in the chart is summarized. Valid values:

  • Type: ReportSummaryType (enumeration of type string)
  • Required: No
  • Description: Specifies the aggregation method—such as Sum, Average, Min, and Max—for the summary value. Use the column field to specify the summary value to use for the aggregation. You don’t need to specify this field for RowCount or custom summary formulas.
  • Type: ChartAxis (enumeration of type string)
  • Required: No
  • Description: Specifies the axis or axes to use on the chart. Use the column field to specify the summary value to use for the axis.
  • Type: string
  • Required: Yes

An enumeration of type string that defines the chart type. For information on each of these chart types, see Chart Types in Salesforce Help.

CustomDetailFormulas defines row-level formulas for reports.

  • Type: string
  • Required: Yes
  • Description: Required. The custom formula. For example, AMOUNT:SUM + OPP_QUANTITY:SUM
  • Type: ReportCustomDetailFormulaDatatype
  • Required: Yes
  • Description: Required. Specifies the data type for formatting and display of the formula results.
  • Type: string
  • Required: No
  • Description: The formula description. Maximum: 255 characters.
  • Type: string
  • Required: Yes
  • Description: Required. The internal development name of the formula, for example, FORMULA1. This name is used to reference custom formulas from other report components, including conditional highlighting.
  • Type: string
  • Required: Yes
  • Description: Required. The name that identifies this formula.
  • Type: int
  • Required: No
  • Description: The formula result is calculated to the specified number of decimal places. Valid values 0 through 18.

ReportAggregate defines custom summary formulas on summary, matrix, and joined reports. For more information on these fields, see Add a Summary Formula Column to a Report in Salesforce Help.

  • Type: string
  • Required: No
  • Description: Defines the row grouping level at which you want your custom summary formula to be displayed. This field is available in API version 15.0.
  • Type: string
  • Required: Yes
  • Description: Required. The custom summary formula. For example, AMOUNT:SUM + OPP_QUANTITY:SUM
  • Type: string
  • Required: No
  • Description: The custom summary formula description. Maximum: 255 characters.
  • Type: string
  • Required: Yes
  • Description: Required. The internal development name of the custom summary formula, for example, FORMULA1. This name is used to reference custom summary formulas from other report components, including conditional highlighting.
  • Type: string
  • Required: No
  • Introduced: API version 15.0
  • Description: Defines the column grouping level at which you want your custom summary formula to be displayed.
  • Type: boolean
  • Required: Yes
  • Description: Required. true displays the formula result in the report. false doesn’t display the result in the report.
  • Type: boolean
  • Required: No
  • Introduced: API version 25.0
  • Description: Determines whether the custom summary formula is a cross-block formula, which is available with joined reports. true indicates a cross-block custom summary formula. false indicates a standard custom summary formula.
  • Type: string
  • Required: Yes
  • Description: Required. The custom summary formula label (name).
  • Type: string
  • Required: No
  • Description: Required for joined reports. Specifies the reportType of the blocks to which the aggregate can be added.
  • Type: int
  • Required: No
  • Description: The formula result is calculated to the specified number of decimal places. Valid values 0 through 18.

An enumeration of type string that specifies the data type for formatting and display of custom summary formula results.

ReportAggregateFilter defines custom summary formula filters on summary, matrix, and joined reports.

  • Type: string
  • Required: Yes
  • Description: Required. The name of the report aggregate to apply the filter to.
  • Type: string
  • Required: Yes
  • Description: Required. The filter operator.
  • Type: string
  • Required: Yes
  • Description: Required. The filter value.

ReportAggregateReference defines the developer name used for custom summary formulas in joined reports.

  • Type: string
  • Required: Yes
  • Description: Required. The developerName of the ReportAggregate, which specifies the custom summary formula used in a block of a joined report.

ReportBlockInfo defines blocks in a joined report.

  • Type: ReportAggregateReference[]
  • Required: No
  • Description: Lists the aggregates that represent the custom summary formulas used in a joined report block.
  • Type: string
  • Required: Yes
  • Introduced: API version 25.0
  • Description: Required. blockId is used in cross-block custom summary formulas and joined report charts to identify the block containing each summary field. blockId is assigned automatically. Valid values are B1 through B5.
  • Type: string
  • Required: Yes
  • Description: Required. Refers to the entity used to join blocks in a joined report. The entity provides a list of fields that are available for globally grouping across the blocks.

ReportBucketField defines a bucket to be used in the report.

  • Type: ReportBucketFieldType (enumeration of type string)

  • Required: Yes

  • Description: Required. Specifies the type of bucket. Valid values:

    • text
    • number
    • picklist
  • Type: string
  • Required: Yes
  • Description: Required. A unique name used as the <field> value to display a bucket field in the column list and other report components, including sort, filter, list, group, and chart. Must be of the format BucketField_name. For example, BucketField_BusinessSize.
  • Type: string
  • Required: Yes
  • Description: Required. The bucket field label. Maximum 40 characters. Any line breaks, tabs, or multiple spaces at the beginning or end of the label are removed. Any of these characters within the label are reduced to a single space.
  • Type: ReportFormulaNullTreatment (enumeration of type string)
  • Required: No
  • Description: For numeric bucket fields only. Specifies whether empty values are treated as zeros (z) or not (n).
  • Type: string
  • Required: No
  • Description: The label of the container for unbucketed values.
  • Type: string
  • Required: Yes
  • Description: Required. The source field that the bucket is applied to. For example, SALES or INDUSTRY.
  • Type: boolean
  • Required: No

  • Type: ReportBucketFieldValue[]

  • Required: No

  • Description: Defines one bucket value used in the bucket field.

    While this name is plural, it represents a single bucket. In typical use, a bucket field contains multiple buckets.

  • Type: string
  • Required: No
  • Type: string
  • Required: No
  • Type: string
  • Required: No

ReportBucketFieldValue defines a bucket value used in the bucket field.

  • Type: ReportBucketFieldSourceValue[]

  • Required: No

  • Description: The value of a bucket in the bucket field.

    In numeric buckets, the first value must only have to and last value must only have from. All other values must have both to and from.

  • Possible values:

    • sourceValue — Used for picklist and text bucket fields. For picklists, describes the picklist item in the bucket. For example, the sourceValue of a bucket on TYPE could be Customer. For text, the full string for the item in the bucket. For example, the sourceValue of a bucket on ADDRESS_STATE1 could be NY.
    • from — Used only on numeric bucket fields. A non-inclusive lower bound for a numeric bucket range. This value must be a number.
    • to — Used only on numeric bucket fields. The inclusive upper bound for a numeric bucket range. This value must be a number.
  • Type: string
  • Required: Yes
  • Description: Required. The name of a specific bucket value within the bucket field.

ReportChart represents charts on summary, matrix, and joined reports.

  • Type: string
  • Required: No
  • Description: Specifies the beginning color (in HTML format) for a gradient color background.
  • Type: string
  • Required: No
  • Description: Specifies the end color (in HTML format) for a gradient color background.
  • Type: ChartBackgroundDirection (enumeration of type string)
  • Required: No
  • Description: Specifies the direction for a gradient color background. Use with backgroundColor1 to specify the beginning color and backgroundColor2 to specify the end color for the gradient design. Use white for both if you don’t want a background design.
  • Possible values:
    • Diagonal
    • LeftToRight
    • TopToBottom
  • Type: boolean
  • Required: No
  • Introduced: API version 17.0
  • Description: Specifies whether to display values, labels, and percentages when hovering over charts. Hover details depend on chart type. Percentages apply to pie, donut, and funnel charts only.
  • Type: boolean
  • Required: No
  • Type: string
  • Required: No
  • Description: Specifies the field by which to group data. This data is displayed on the X-axis for vertical column charts and on the Y-axis for horizontal bar charts.

  • Type: ChartLegendPosition (enumeration of type string)

  • Required: No

  • Description: Required.

    The location of the legend with respect to the chart.

  • Possible values:

    • Bottom
    • OnChart
    • Right
  • Type: string
  • Required: No
  • Description: For grouped chart types: Specifies the field by which to group the data.
  • Type: boolean
  • Required: No
  • Description: For bar and line charts: Specifies whether the chart displays names for each axis.
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Type: ReportSummaryType (enumeration of type string)
  • Required: No
  • Description: Defines how to summarize the chart data. For example, Sum. No longer supported in version API 17.0 and later. See chartSummaries.
  • Possible values:
    • Sum — Total
    • Average — Average
    • Maximum — Largest value
    • Minimum — Smallest value
    • Unique — Unique values
    • Median — Median value
    • Noop — The summary is a no-op.
    • None — The field isn’t summarized.
  • Type: double
  • Required: No
  • Description: When specifying the axis range manually: Defines the ending value.
  • Type: double
  • Required: No
  • Description: When specifying the axis range manually: Defines the starting value.
  • Type: string
  • Required: Yes
  • Description: Required. Specifies the field by which to summarize the chart data. Typically this field is displayed on the Y-axis. No longer supported in version API 17.0 and later. See chartSummaries.
  • Type: string
  • Required: No
  • Description: The color (in HTML format) of the chart text and labels.

  • Type: int (enumeration of type string)

  • Required: No

  • Description: The size of the chart text and labels.

    The maximum size is 18. Larger values are shown at 18 points.

  • Possible values:

    • 8
    • 9
    • 10
    • 12
    • 14
    • 18
    • 24
    • 36
  • Type: string
  • Required: No
  • Description: The chart title. Max 255 characters.
  • Type: string
  • Required: No
  • Description: The color (in HTML format) of the title text.

  • Type: int (enumeration of type string)

  • Required: No

  • Description: The size of the title text.

    The maximum size is 18. Larger values are shown at 18 points.

  • Possible values:

    • 8
    • 9
    • 10
    • 12
    • 14
    • 18
    • 24
    • 36

An enumeration of type string that specifies the chart size.

ReportColorRange defines conditional highlighting for report summary data.

  • Type: string
  • Required: Yes
  • Description: Required. Specifies the field whose value ranges are represented by background colors.
  • Type: double
  • Required: No
  • Description: Required. Specifies the number that separates the mid color from the high color.
  • Type: string
  • Required: Yes
  • Description: Required. Specifies the color (in HTML format) to represent data that falls into the high number range. This color spans from the highBreakpoint value.
  • Type: double
  • Required: No
  • Description: Required. Specifies the number that separates the low color from the mid color.
  • Type: string
  • Required: Yes
  • Description: Required. Specifies a color (in HTML format) to represent data that falls into the low value range, below the lowBreakpoint value.
  • Type: string
  • Required: Yes
  • Description: Required. Specifies a color (in HTML format) to represent data that falls into the mid value range.

ReportColumn defines how fields (columns) are displayed in the report.

  • Type: string
  • Required: Yes
  • Description: Required. The field name. For example, AGE or OPPORTUNITY_NAME
  • Type: boolean
  • Required: No
  • Introduced: API version 65.0
  • Description: Indicates whether the column is extended (true) or not (false).
  • Type: boolean
  • Required: No
  • Introduced: API version 29.0
  • Description: In historical trend reports, displays greater Date values as green and greater Amount values as red, reversing the default colors.
  • Type: boolean
  • Required: No
  • Introduced: API version 29.0
  • Description: In historical trend reports, adds a column displaying the difference between current and historical Date and Amount values.

ReportCrossFilter represents the cross filter functionality in reports.

  • Type: ReportFilterItem[]
  • Required: No
  • Description: Represents the subfilters of a cross filter. There can be up to five subfilters. This field requires the following attributes.
  • Possible values:
    • Column
    • Operator
    • Value
  • Type: ObjectFilterOperator (enumeration of type string)
  • Required: Yes
  • Description: The action indicating whether to include or exclude an object. Valid values: with and without.
  • Type: string
  • Required: Yes
  • Description: The field from the parent object used for the cross filter.
  • Type: string
  • Required: Yes
  • Description: The child object used for the cross filter.
  • Type: string
  • Required: Yes
  • Description: The field from the child object that is used to join the parent.
  • Type: string
  • Required: Yes
  • Type: string
  • Required: Yes
  • Type: string
  • Required: No
  • Description: A description of this component. The description should explain the component’s purpose and behavior so that administrators and developers understand when to use it.
  • Type: string
  • Required: Yes
  • Description: The unique developer name of this component. Used as an API reference and must follow Salesforce identifier rules.
  • Type: string
  • Required: Yes
  • Description: The label that identifies this component in the Salesforce UI and in metadata listings. Character limits and translation behavior follow the enclosing type.
  • Type: int
  • Required: Yes

An enumeration of type string that specifies the data type for formatting and display of row-level formula results.

  • Type: string
  • Required: Yes
  • Type: string
  • Required: Yes
  • Type: DataCategoryFilterOperation (enumeration of type string)
  • Required: Yes

ReportFilter limits the report results by filtering data on specified fields.

  • Type: string
  • Required: No
  • Description: Specifies filter logic conditions.

  • Type: ReportFilterItem[]

  • Required: No

  • Description: The criteria by which you want to filter report data, either by comparing historical values or by applying a date range.

  • Type: Language (enumeration of type string)
  • Required: No
  • Description: The language used when a report filters against a picklist value using the operators contains or startsWith. For a list of valid language values, see Language.

ReportFilterItem limits the report results by filtering data on specified fields.

  • Type: string
  • Required: Yes
  • Description: Required. The field in which to filter data. For example, AMOUNT

  • Type: boolean

  • Required: No

  • Introduced: API version 29.0

  • Description: Indicates whether the filter is a column-to-column (field-to-field) filter.

    Available in API version 29.0 and later for historical trending reports. Available in API version 48.0 and later for general reports.

  • Type: boolean
  • Required: No
  • Introduced: API version 38.0
  • Description: Optional. Indicates whether the report filter is unlocked (true) or locked (false). You can edit unlocked filters on the report run page in Lightning Experience. If unspecified, the default value is false.
  • Type: FilterOperation (enumeration of type string)
  • Required: Yes
  • Description: Required. An enumeration of type string that defines the operator used to filter the data, for example, greaterThan.
  • Possible values:
    • equals
    • notEqual
    • lessThan
    • greaterThan
    • lessOrEqual
    • greaterOrEqual
    • contains
    • notContain
    • startsWith
    • includes
    • excludes
    • within — (DISTANCE criteria only)
  • Type: string
  • Required: No
  • Introduced: API version 29.0
  • Description: Represents the date value, either relative (in the format N_DAYS_AGO:2) or absolute (in the format yyyy-MM-dd).
  • Type: string
  • Required: No
  • Description: The value by which you want to filter the data, for example, 1000. The Metadata API filter condition values don’t always match the values that you enter in the report wizard. For example, in the Metadata API dates are always converted to the US date format and values entered in a non-US English language can be converted to a standard US English equivalent.

An enumeration of type string that defines the report format.

Defines conditional highlighting for report summary data. You can specify up to 5 formatting rules per report.

  • Type: string
  • Required: Yes
  • Description: Required. Specifies the field whose value ranges are represented by colors.
  • Type: ReportFormattingRuleValue[]
  • Required: No
  • Description: Required. Specifies the background colors and associated ranges for formatted data values.

Specifies the background colors and associated ranges for formatted data values. You can specify up to 3 background colors and 0–3 range upper bounds. Valid values:

  • Type: string
  • Required: No
  • Description: (Required) Specifies a highlighting color for the field in columnName. Must be a valid hex color string such as #54C254. At least one color is required. You can optionally specify a different color for up to 3 ranges as determined by rangeUpperBound. If you don’t specify a color for a particular range, the background is transparent.

  • Type: double

  • Required: No

  • Description: Delineates a range to which a background color applies. If you don’t specify an upper bound for a particular range, the bound is assumed to be plus infinity. The following example sets the background color for the Sales column to #B50E03 for aggregate sales less than or equal to 100, sets no background for sales from 100 to 1000, and sets the background color to #006714 for sales greater than 1000.

An enumeration of type string that defines how report fields are summarized.

ReportGrouping defines how to group, subtotal, and sort data for summary, matrix, and joined reports.

  • Type: ReportAggrType (enumeration of type string)
  • Required: No
  • Description: The type of aggregate value to sort by.
  • Possible values:
    • Sum
    • Average
    • Maximum
    • Minimum
    • RowCount
    • Unique
    • Median
    • Noop
  • Type: string
  • Required: Yes
  • Description: Required. The field by which you want to summarize data. For example, CAMPAIGN_SOURCE
  • Type: string
  • Required: No
  • Description: The hierarchy API name for this report.
  • Type: string
  • Required: No
  • Description: The API name of the column, aggregate, or custom summary field used to order the grouping.
  • Type: ReportSortType (enumeration of type string)
  • Required: No
  • Description: Indicates if the grouping is sorted by a column, aggregate, or custom summary field.
  • Possible values:
    • Column
    • Aggregate
    • CustomSummaryFormula

ReportHistoricalSelector defines a date range for historical data.

  • Type: string[]
  • Required: No
  • Introduced: API version 29.0
  • Description: Represents the date value to apply a historical filter, either relative (in the format N_DAYS_AGO:2) or absolute (in the format yyyy-MM-dd). If unspecified, it’s assumed that the filter is applied to all the columns the user sees.

ReportParam represents settings specific to a report type, especially options that let you filter a report to certain useful subsets.

  • Type: string
  • Required: Yes
  • Description: Required. Specifies a specific reportType setting.
  • Type: string
  • Required: Yes
  • Description: Required. The setting value.

An enumeration of type string that defines how report fields are summarized.

ReportTimeFrameFilter represents the report time period.

  • Type: string
  • Required: Yes
  • Description: Required. The date field on which to filter data. For example, CLOSE_DATE
  • Type: date
  • Required: No
  • Description: When interval is INTERVAL_CUSTOM, specifies the end of the custom time period.
  • Type: date
  • Required: No
  • Description: When interval is INTERVAL_CUSTOM, specifies the start of the custom time period.

An enumeration of type string that defines the order in which data is sorted in the report fields.

An enumeration of type string that defines the time period by which to group data.

An enumeration of type string that defines the period.

A sample XML snippet using cross filters to build an Accounts report for cases where case status isn’t closed:

This sample was generated using the API version 23.0.

A sample XML report definition:

A sample XML report definition:

This metadata type doesn’t support the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.