Report Type

Return metadata about a report type.

Syntax 

URI: /services/data/vXX.X/analytics/reportTypes/type

Formats: JSON

HTTP methods

MethodDescription
GETReturn metadata about a report type

GET Request Body 

A notification object with desired changes.

PropertyTypeDescription
reportMetadataReport metadataUnique identifiers for groupings and summaries.
reportTypeMetadataReport type metadataFields in each section of a report type plus filter information for those fields.
reportExtendedMetadataReport extended metadataAdditional information about summaries and groupings.

Report extended metadata

PropertyTypeDescription
aggregateColumnInfoAggregate column informationIncludes all report summaries such as, Record Count, Sum, Average, Max, Min, and custom summary formulas. Contains values for each summary listed in the report metadata aggregates.
detailColumnInfoDetail column informationTwo properties for each field that has detailed data identified by its unique API name. The detailed data fields are also listed in the report metadata.
groupingColumnInfoGrouping column informationMap of each row or column grouping to its metadata. Contains values for each grouping identified in the groupingsDown and groupingsAcross list.
historicalColumnInfoHistorical column informationProvides additional information on columns that exist only in historical trending reports. (This property is applicable only to historical trending reports.)

Aggregate column information

PropertyTypeDescription
labelStringDisplay name for record count, or the summarized or custom summary formula field.
dataTypeStringData type of the summarized or custom summary formula field.
acrossGroupingContextStringColumn grouping in the report where the custom summary formula is displayed. As this example shows in the JSON response and in the custom summary formula editor of the matrix report, the custom summary formula is set at the grand summary level for the columns.
downGroupingContextStringRow grouping in the report where the custom summary formula is displayed. In this example, the custom summary formula for a summary report is displayed at the first grouping level. This example is shown in both the JSON response and in the custom summary formula editor of the summary report.

Example acrossGroupingContext for a matrix report:

1{ 
2   "reportExtendedMetadata" : {
3      "aggregateColumnInfo" : {
4         "FORMULA1" : {
5            "label" : "Stalled Oppty Avg",
6            "dataType" : "Percent",
7            "acrossGroupingContext" : "GRAND_SUMMARY",
8            "downGroupingContext" : "GRAND_SUMMARY"
9         },
10      }
11   }
12}

Grouping level where the custom summary formula is displayed for a matrix report

Example downGroupingContext for a summary report:

1{
2   "reportExtendedMetadata" : {
3      "aggregateColumnInfo" : {
4...},
5         "FORMULA1" : { 
6            "label" : "Average Won",
7            "dataType" : "Number",
8            "acrossGroupingContext" : null,
9            "downGroupingContext" : "TYPE"
10         },
11      }
12   }
13}

Grouping level where the custom summary formula is displayed in a summary report

Detail column information

PropertyTypeDescription
labelStringThe localized display name of a standard field, the ID of a custom field, or the API name of a bucket field that has detailed data.
dataTypeStringThe data type of the field that has detailed data. Possible values are: string, boolean, combobox, currency, date, datetime, double, email, html, id, int, multipicklist, number, percent, phone, picklist, reference, text, textarea, time, or url.
entityColumnNameStringDescribes the relationship between an sObject and a report field by returning the sObject and sObject field name that a report field maps to. The value returned is formatted as sObject.sObject field. The property is part of an object that describes a report field, such as an object in the columns[] array of a report type object from reportTypeMetadata. For example, on the LAST_UPDATE_BY column, the value of entityColumnName is “User.Name”, which tells us that it’s mapped to the Name field on the User sObject. For a standard report column that uses a lookup field, entityColumnName returns the related object and field. For example, the LAST_UPDATE_BY column returns "User.Name". For a custom lookup field, entityColumnName can return the object that contains the field and the field’s API name instead of the related object’s field. For example, a custom lookup-to-User field on a custom object can return "MyCustomObject.MyCustomField". Row-level formulas aren’t directly mapped to sObject fields like report fields, but they still have an entityColumnName property. For row-level formulas, the value of entityColumnName is CDF1.
filterValuesString arrayAll filter values for a field, if the field data type is of picklist, multi-select picklist, boolean, or checkbox. For example, checkbox fields always have a value of True or False. For fields of other data types, the filter value is an empty array because their values can’t be determined. Filter values have two properties: name (unique API name for a filter value, of type string) and label (display name of a filter value, of type string).
filterableBooleanFalse means that the field is of a type that can’t be filtered. For example, fields of the type Encrypted Text can’t be filtered.
isLookupBooleanSpecifies whether a field is a lookup (true) or not (false).
labelStringDisplay name of a field.
uniqueCountableBooleanSpecifies whether a field supports unique count (true) or not (false)

Example entityColumnName:

1"reportTypeMetadata" : {
2    "categories" : [ {
3      "columns" : {
4        "LAST_UPDATE_BY" : {
5          "allowedInCustomDetailFormula" : true,
6          "bucketable" : true,
7          "dataType" : "string",
8          "entityColumnName" : "User.Name",
9          "fieldToFieldFilterable" : false,
10          "filterValues" : [ ],
11          "filterable" : true,
12          "inactiveFilterValues" : [ ],
13          "isCustom" : false,
14          "isLookup" : true,
15          "label" : "Last Modified By",
16          "maxLength" : null,
17          "uniqueCountable" : true
18        }
19      }
20    } ]
21  }

Grouping column information

PropertyTypeDescription
labelStringDisplay name of the field or bucket field used for grouping.
dataTypeStringData type of the field used for grouping. Possible values are: string, boolean, combobox, currency, date, datetime, double, email, html, id, int, multipicklist, number, percent, phone, picklist, reference, text, textarea, time, or url.
groupingLevelIntegerLevel of the grouping. Value can be 0, 1, or 2 (first, second, or third row level grouping in summary reports), or 0 or 1 (first or second row or column level grouping in a matrix report).

Historical column information

PropertyTypeDescription
baseFieldStringIndicates the base column for the historical data. Example: For the historical column Opportunity__hd.Amount__hst.N_DAYS_AGO:1, which represents the historical Amount column from one day ago in an Opportunity report, the base column is Opportunity.Amount.
historicalColumnStringThe specific historical column name. Example: The historical column for Opportunity__hd.Amount__hst.N_DAYS_AGO:1 is Opportunity__hd.Amount__hst.
historicalSnapshotDateStringThe snapshot date for this historical column. Example: For the historical column Opportunity__hd.Amount__hst.N_DAYS_AGO:1, the snapshot date is N_DAYS_AGO:1, which is one day ago.
isHistoricalChangeBooleanTrue if the column represents change between two historical columns.

Report metadata

PropertyTypeDescription
aggregatesArray of stringsUnique identities for summary or custom summary formula fields in the report.
allowedInCustomDetailFormulaBooleanSpecifies whether a field can be referenced in a row-level formula (true) or not (false).
bucketsBucket fieldDescribes a bucket field.
chartChart[]Details about the chart used in a report.
crossFiltersCross filter[]Cross filters applied to the report.
customDetailFormulaCustom Detail Formula[]An array of objects that describes row-level formulas.
customSummaryFormulaCustom summary formulaDescribes a custom summary formulas.
currencyStringReport currency, such as USD, EUR, GBP, for an organization that has Multi-Currency enabled. Value is null if the organization does not have Multi-Currency enabled.
dashboardSettingName/value pairAllows saving of dashboard settings to allow for reports with row limit filters on dashboards. Can be configured on a report for Top-N reports. The Name and Value fields in dashboardSetting are used as Grouping and Aggregate in dashboard components.
detailColumnsArray of stringsUnique API names for the fields that have detailed data.
developerNameStringReport API name.
divisionStringDetermines the division of records to include in the report. For example, West Coast and East Coast. Available only if your organization uses divisions to segment data and you have the “Affected by Divisions” permission. If you do not have the “Affected by Divisions” permission, your reports include records in all divisions.
folderIdStringID of the folder that contains the report. When the report is in the My Personal Custom Reports folder, folderId = userId. When the report is in the Unfiled Public Reports folder, folderId = orgId.
groupingsAcrossGroupings across[]Unique identities for each column grouping in a report. The identity is an empty array for reports in summary format as it can’t have column groupings, BucketField_(ID) for bucket fields, or the ID of a custom field when the custom field is used for a column grouping.
groupingsDownGroupings down[]Unique identities for each row grouping in a report. The identity is BucketField_(ID) for bucket fields, or the ID of a custom field when the custom field is used for grouping.
hasDetailRowsBooleanIndicates whether to include detailed data with the summary data.
hasRecordCountBooleanIndicates whether the report shows the record count.
historicalSnapshotDatesArray of stringsList of historical snapshot dates.
idStringUnique report ID.
nameStringDisplay name of the report.
presentationOptionsReport presentation optionsDisplay options in the Lightning Report Builder.
reportBooleanFilterStringLogic to parse custom field filters. Value is null when filter logic is not specified.
reportFiltersFilter details[]List of each custom filter in the report along with the field name, filter operator, and filter value.
reportFormatStringFormat of the report. Possible values are TABULAR, SUMMARY, MATRIX, or MULTI_BLOCK. The MULTI_BLOCK property is available in API version 43.0 and later.
reportTypeReport typeUnique API name and display name for the report type. type (string) is the unique identifier of the report type. label (string) is the display name of the report type.
scopeStringDefines the scope of the data on which you run the report. For example, you can run the report against all opportunities, opportunities you own, or opportunities your team owns. Valid values depend on the report type.
showGrandTotalBooleanIndicates whether the report shows the grand total.
showSubtotalsBooleanIndicates whether the report shows subtotals, such as column or row totals.
sortByArray of stringsAPI name of the field on which the report is sorted and the direction of the sort (asc or desc).
standardDateFilterArray of stringsStandard date filters available in reports. Each standard date filter contains the following properties: column (API name of the date field on which you filter the report data), durationValue (the range for which you want to run the report; the value is a date literal or ‘CUSTOM.’), startDate (start date), and endDate (end date).
standardFiltersArray of stringsList of filters that show up in the report by default. The filters vary by report type. For example, standard filters for reports on the Opportunity object are Show, Opportunity Status, and Probability. This list appears as name-value string pairs.
supportsRoleHierarchyBooleanIndicates whether the report type supports role hierarchy filtering (true) or not (false).
topRowsTop rowsDescribes a row limit filter applied to the report.
userOrHierarchyFilterIdStringUnique user or role ID of the user or role used by the report’s role hierarchy filter. If specified, a role hierarchy filter is applied to the report. If unspecified, no role hierarchy filter is applied to the report.

Example aggregates identities:

  • 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!<customfieldID> represents the sum of a custom field column. For custom fields and custom report types, the identity is a combination of the summary type and the field ID.
  • u!{column_name} represents a unique count of values for the specified {column_name}. For example, u!_AccountName_ returns the number of unique account name values in the AccountName field.

Example reportBooleanFilter. This is an example of a report filtered to show opportunities for accounts that are either of customer or partner type OR their annual revenue exceeds 100K AND they are medium or large sized businesses. The filters are processed by the logic, “(1 OR 2) AND 3.”

1{
2...
3        "reportBooleanFilter": "(1 OR 2) AND 3",
4        "reportFilters": [
5            {
6                "value": "Analyst,Integrator,Press,Other",
7                "column": "TYPE",
8                "operator": "notEqual"
9            },
10            {
11                "value": "100,000",
12                "column": "SALES",
13                "operator": "greaterThan"
14            },
15            {
16                "value": "Small",
17                "column": "Size",
18                "operator": "notEqual"
19            }
20        ]
21    }
22}

Example sortBy:

1"sortBy":[{"sortColumn":"Account_ID","sortOrder":"asc"}]

Chart

PropertyTypeDescription
chartTypeStringType of chart.
groupingsStringReport grouping.
hasLegendBooleanIndicates whether the report has a legend.
showChartValuesBooleanIndicates whether the report shows chart values.
summariesArray of stringsUnique identities for summary or custom summary formula fields in the report.
summaryAxisLocationsStringSpecifies the axis that shows the summary values. Valid values are X and Y.
titleStringName of the chart.

Example summaries identities:

  • 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!<customfieldID> represents the sum of a custom field column. For custom fields and custom report types, the identity is a combination of the summary type and the field ID.

Groupings down

PropertyTypeDescription
nameStringAPI name of the field used as a row grouping.
sortOrderStringOrder in which data is sorted within a row grouping. Value can be asc for ascending order or desc for descending order.
dateGranularityStringInterval set on a date field that’s used as a row grouping. Value can be Day, Calendar Week, Calendar Month, Calendar Quarter, Calendar Year, Fiscal Quarter, Fiscal Year, Calendar Month in Year, or Calendar Day in Month.
sortAggregateStringSummary field that’s used to sort data within a grouping in a report that’s in summary format. Applies if you have the Aggregate Sort feature enabled as part of its pilot program. The value is null when data within a grouping is not sorted by a summary field. In this example, data grouped by Account Owner is sorted by the sum of Annual Revenue.

Example sortAggregate:

1{
2    "aggregates": ["s!SALES","RowCount"],
3    "groupingsDown": [
4        {
5            "name": "USERS.NAME",
6            "sortOrder": "Desc",
7            "dateGranularity": "None",
8            "sortAggregate": "s!SALES"
9        }
10    ]
11}

Report presentation options

PropertyTypeDescription
hasStackedSummariesBooleanIndicates whether stacked summaries are enabled in the report.
historicalColumnsHistorical column presentation optionsPresentation options of the historical column.

Example historicalColumns presentation options:

1"presentationOptions" : {
2  "historicalColumns" : {
3    "Opportunity__hd.CloseDate__hst" : {
4      "decreaseIsPositive" : false,
5      "showChanges" : false
6    },
7    "Opportunity__hd.Amount__hst" : {
8      "decreaseIsPositive" : false,
9      "showChanges" : true
10    }
11  }
12}

Historical column presentation options

PropertyTypeDescription
decreaseIsPositiveBooleanIndicates whether a negative change (decrease in value) is displayed in green instead of red in Lightning Report Builder.
showChangesBooleanIndicates whether to display a change column for a given historical column.

Groupings across

PropertyTypeDescription
nameStringAPI name of the field used as a column grouping.
sortOrderStringOrder in which data is sorted within a column grouping. Value can be asc for ascending order or desc for descending order.
dateGranularityStringInterval set on a date field used as a column grouping. Value can be Day, Calendar Week, Calendar Month, Calendar Quarter, Calendar Year, Fiscal Quarter, Fiscal Year, Calendar Month in Year, or Calendar Day in Month.

Filter details

PropertyTypeDescription
columnStringUnique API name for the field that’s being filtered.
filterTypeStringDescribes the type of value used to filter report data. Valid values are fieldToField (filters report data by comparing values of one field with the values of a second field), fieldValue (filters report data by comparing values of a field with a defined value), or null (if null, the filterType defaults to fieldValue).
isRunPageEditableBooleanIndicates if this is an editable filter in the user interface.
operatorStringUnique API name for the condition used to filter a field such as “greater than” or “not equal to.” Filter conditions depend on the data type of the field. Valid values are equals, notEqual, lessThan, greaterThan, lessOrEqual, greaterOrEqual, contains, notContain, startsWith, includes, excludes, or within (DISTANCE criteria only).
valueStringValue by which a field is filtered. For example, the field Age can be filtered by a numeric value. For datetime fields, if you make a POST request and specify a calendar date without including a time, then a default time gets included. The time defaults to midnight minus the difference between your timezone and Greenwich Mean Time (GMT). For example, if you specify 8/8/2015 and your timezone is Pacific Standard Time (GMT-700), then the API returns 2015-08-08T07:00:00Z.

Example filterType. In this example, the first filter is a field-to-field filter that compares the Amount field with Projected Amount field. The second filter is a field filter that returns records for which a row-level formula returns more than 0.

1"reportFilters" : [ {
2      "column" : "AMOUNT",
3      "filterType" : "fieldToField",
4      "isRunPageEditable" : true,
5      "operator" : "notEqual",
6      "value" : "PROJECTED_AMOUNT"
7    }, {
8      "column" : "CDF1",
9      "filterType" : "fieldValue",
10      "isRunPageEditable" : true,
11      "operator" : "greaterThan",
12      "value" : "0"
13} ]

Bucket field

PropertyTypeDescription
bucketTypeBucketTypeThe type of bucket. Possible values are number, percent, and picklist
developerNameStringAPI name of the bucket.
labelStringUser-facing name of the bucket.
nullTreatedAsZeroBooleanSpecifies whether null values are converted to zero (true) or not (false).
otherBucketLabelStringName of the fields grouped as “Other” (in buckets of BucketType PICKLIST).
sourceColumnNameStringName of the bucketed field.
valuesArray of BucketTypeValuesDescribes the values included in the bucket field..

Bucket field value

PropertyTypeDescription
labelStringThe user-facing name of the bucket.
sourceDimensionValuesStringA list of the values from the source field included in this bucket category (in buckets of type PICKLIST and buckets of type TEXT).
rangeUpperBoundDoubleThe greatest range limit under which values are included in this bucket category (in buckets of type NUMBER).

Cross filter

PropertyTypeDescription
criteriaArray of Filter details[]Information about how to filter the relatedEntity. Use to relate the primary entity with a subset of the relatedEntity.
includesObjectBooleanSpecifies whether objects returned have a relationship with the relatedEntity (true) or not (false).
primaryEntityFieldStringThe name of the object on which the cross filter is evaluated.
relatedEntityStringThe name of the object that the primaryEntityField is evaluated against. (The right-hand side of the cross filter).
relatedEntityJoinFieldStringThe name of the field used to join the primaryEntityField and relatedEntity.

Custom Detail Formula

PropertyTypeDescription
decimalPlacesIntegerFormats the value returned by the row-level formula. It is required for numeric return values, invalid for non-numeric return values.
descriptionStringUser-defined description of the row-level formula.
formulaStringSpecifies the formula expression to be evaluated. All report type fields, except bucketed fields and historical tracking fields can be referenced.
formulaTypeStringSpecifies the return type of the formula. Valid values include date, datetime, number, or text.
labelStringSpecifies a name for the row-level formula.

Custom summary formula

PropertyTypeDescription
labelStringThe user-facing name of the custom summary formula.
descriptionStringThe user-facing description of the custom summary formula.
formulaTypeStringThe format of the numbers in the custom summary formula. Possible values are number, currency, and percent.
decimalPlacesIntegerThe number of decimal places to include in numbers.
downGroupStringThe name of a row grouping when the downGroupType is CUSTOM. Null otherwise.
downGroupTypeStringWhere to display the aggregate of the custom summary formula. Possible values are all, custom, and grand_total.
acrossGroupStringThe name of a column grouping when the accrossGroupType is CUSTOM. Null otherwise.
acrossGroupTypeStringWhere to display the aggregate of the custom summary formula. Possible values are all, custom, and grand_total.
formulaStringThe operations performed on values in the custom summary formula.

Top rows

PropertyTypeDescription
rowLimitIntegerThe number of rows returned in the report.
directionStringThe sort order of the report rows.

Report type metadata

PropertyTypeDescription
categoriesCategories[]Returns all row-level formulas in a report as an object identical to the other categories objects. For row-level formulas, these properties are always false: allowedInCustomDetailFormula, Bucketable, Filterable, isCustom, and isLookup. For row-level formulas, these properties are always null: filterValues and inactiveFilterValues.
dataTypeFilterOperatorMapFilter operator referenceLists all the possible field data types that can be used to filter the report. Each data type, such as phone, percent, currency, or picklist has two properties: name (string), a unique API name for each field type’s filter criteria—use this API name in the metadata to define filter criteria for a report; and label (string), the display name for each filter criteria available to fields of a particular data type. For example, multipicklist fields can have for filter criteria, “equals,” “not equal to,” “includes,” and “excludes.” Bucket fields are considered to be of string data type.
dateGranularityInfosdateGranularityInfos[]An array of objects each of which specifies a measure of time used to group date fields (day, week, month, fiscal quarter, and more).
divisionInfoDivision info[]Default division and list of all possible record-level divisions that can be used in a report.
objectsObjects info[]List of objects included in report type. Available in API version 54.0 and later.
scopeInfoScope info[]Scope of the data on which you run the report. For example, you can run the report against all opportunities, opportunities you own, or opportunities your team owns. Valid values depend on the report type.
standardDateFilterDurationGroupsStandard date filter duration groups[]List of standard date filters available in reports.
standardFilterInfosArray of stringsList of filters that show up in the report by default. The filters vary by report type. For example, standard filters for reports on the Opportunity object are Show, Opportunity Status, and Probability. This list appears as name-value string pairs.
supportsJoinedFormatBooleanSpecifies whether a report type is compatible with joined reports (true) or not (false).

Categories

PropertyTypeDescription
labelStringDisplay name of a section in the report type under which fields are organized. For example, in an Accounts with Contacts custom report type, Account General is the display name of the section that has fields on general account information.
columnsColumn mapInformation for all fields in the report type organized under a particular section’s unique API name.

Column map

PropertyTypeDescription
allowedInCustomDetailFormulaBooleanSpecifies whether a field is whether a field is can be referenced in a row-level formula (true) or not (false).
bucketableBooleanSpecifies whether a field can be used as the basis for a bucket column (true) or not (false).
dataTypeStringData type of the field.
entityColumnNameStringDescribes the relationship between an sObject and a report field by returning the sObject and sObject field name that a report field maps to. The value returned is formatted as sObject.sObject field. The property is part of an object that describes a report field, such as an object in the columns[] array of a report type object from reportTypeMetadata. For example, on the LAST_UPDATE_BY column, the value of entityColumnName is “User.Name”, which tells us that it’s mapped to the Name field on the User sObject. For a standard report column that uses a lookup field, entityColumnName returns the related object and field. For example, the LAST_UPDATE_BY column returns "User.Name". For a custom lookup field, entityColumnName can return the object that contains the field and the field’s API name instead of the related object’s field. For example, a custom lookup-to-User field on a custom object can return "MyCustomObject.MyCustomField". Row-level formulas aren’t directly mapped to sObject fields like report fields, but they still have an entityColumnName property. For row-level formulas, the value of entityColumnName is CDF1.
fieldToFieldFilterableBooleanSpecifies whether a field can be referenced in a field-to-field filter (true) or not (false).
filterValuesString arrayAll filter values for a field, if the field data type is of picklist, multi-select picklist, boolean, or checkbox. For example, checkbox fields always have a value of True or False. For fields of other data types, the filter value is an empty array because their values can’t be determined. Filter values have two properties: name (unique API name for a filter value, of type string) and label (display name of a filter value, of type string).
filterableBooleanFalse means that the field is of a type that can’t be filtered. For example, fields of the type Encrypted Text can’t be filtered.
isCustomBooleanSpecifies whether a column is a custom (true) or standard (false) field.
isLookupBooleanSpecifies whether a field is a lookup (true) or not (false).
labelStringDisplay name of a field.
maxLengthIntegerIndicates the maximum permited number of characters for the value of a column field. If there is no limit, use null.
uniqueCountableBooleanSpecifies whether a field supports unique count (true) or not (false)

Example entityColumnName:

1"reportTypeMetadata" : {
2    "categories" : [ {
3      "columns" : {
4        "LAST_UPDATE_BY" : {
5          "allowedInCustomDetailFormula" : true,
6          "bucketable" : true,
7          "dataType" : "string",
8          "entityColumnName" : "User.Name",
9          "fieldToFieldFilterable" : false,
10          "filterValues" : [ ],
11          "filterable" : true,
12          "inactiveFilterValues" : [ ],
13          "isCustom" : false,
14          "isLookup" : true,
15          "label" : "Last Modified By",
16          "maxLength" : null,
17          "uniqueCountable" : true
18        }
19      }
20    } ]
21  }

dateGranularityInfos

PropertyTypeDescription
labelStringThe name of the time measure as it appears in the application.
valueStringAPI name of the time measure.

Division Info

PropertyTypeDescription
defaultValueStringUsers are assigned a default division that applies to their newly created accounts, leads, and custom objects that are enabled for divisions.
valuesStringAll division values. Division values have two properties: label (display name of a division) and name (unique API name of a division).

Objects Info

PropertyTypeDescription
apiNameStringAPI name of the object.
joinTypeStringPresent for custom report types. Indicates how the object is joined. Valid values are ROOT (primary object), INNER (inner join), or OUTER (outer join).
labelStringDisplay name of the object.

Scope Info

PropertyTypeDescription
defaultValueStringDefault scope of the data on which you run the report.
valuesArray of stringsAll scope values. Valid values depend on the report type. Scope values have the following properties: allowsDivision (allows you to segment the report by this scope), label (display name of the scope), and value (value of the scope).

Standard date filter duration groups

PropertyTypeDescription
labelStringDisplay name of the standard date filter grouping. Valid values are Calendar Year, Calendar Quarter, Calendar Month, Calendar Week, Fiscal Year, Fiscal Quarter, Day and custom value based on a user-defined date range.
standardDateFilterDurationsStandard date filter durations[]Details about each possible relative date filter defined under the standard date filter grouping.

Standard date filter durations

PropertyTypeDescription
endDateStringEnd date of a date filter.
labelStringDisplay name of a date filter. Valid date filters are relative date filters—like Current FY and Current FQ—and custom date filters.
startDateStringStart date of a date filter.
valueStringAPI name of a date filter. Valid date filters are relative date filters—like THIS_FISCAL_YEAR and NEXT_FISCAL_QUARTER—and custom date filters.