Describe

• Report metadata gives information about the report as a whole. Tells you such things as, the report type, format, the fields that are summaries, row or column groupings, filters saved to the report, and so on.

• Report type metadata tells you about all the fields available in the report type, those you can filter, and by what filter criteria.

• Report extended metadata tells you about the fields that are summaries, groupings, and contain record details in the report. A property that displays null indicates that its value is not available.

Resource URL

1/services/data/<latest API version>/analytics/reports/<report ID>/describe

Formats

JSON

HTTP Methods

Response Body

Report metadata

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

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

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

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

Groupings across

Filter details

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

Bucket field value

Cross filter

Custom Detail Formula

Custom summary formula

Top rows

Report type metadata

Categories

Column map

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

Division Info

Objects Info

Scope Info

Standard date filter duration groups

Standard date filter durations

Report extended metadata

Aggregate column information

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}

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}

Detail column information

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

Historical column information