---
schema_version: "1"
id: 8db431278fbe6a7d12ad3255bf29ca17d8209b0bb5f59fcec5fcd47901a419f2
title: Get Report Metadata
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/analytics/api_analytics/guides/examples/reports/sforce-analytics-rest-api-get-reportmetadata.md
canonical_url: https://developer.salesforce.com/docs/analytics/salesforce-analytics-rest-api/guide/sforce-analytics-rest-api-get-reportmetadata.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: 84ffe1b93941416cd13805af6372946cfd27e1098303c7687f99fe85ed71d5fa
products:
  - Salesforce Reports and Dashboards REST API Developer Guide
  - analytics
---

# Get Report Metadata

Report metadata gives information about a report and its report type. It includes information on fields used in the report for filters, groupings, detailed data, and summaries. You can use the metadata to do several things.

-   Find out what fields in the report type you can filter on and by what values.
-   Build custom chart visualizations using the metadata information on fields, groupings, detailed data, and summaries.
-   Change filters in the report metadata during a report run.

To get report metadata, send a GET request to the Describe resource.

## Example

This GET request, `/services/data/v29.0/analytics/reports/00OD0000001ZbP7MAK/describe`, to the Describe resource returns metadata for a matrix report. This includes a bucket field, groupings, summaries, and a custom summary formula.

```nolang
{
    "reportTypeMetadata": {
        "categories": [
            {
                "label": "Opportunity Information",
                "columns": {
                    "CREATED": {
                        "filterValues": [],
                        "label": "Created By",
                        "dataType": "string",
                        "filterable": true
                    },
...
                    "TYPE": {
                        "filterValues": [
                            {
                                "name": "Add-On Business",
                                "label": "Add-On Business"
                            },
                            {
                                "name": "New Business",
                                "label": "New Business"
                            },
                            {
                                "name": "Services",
                                "label": "Services"
                            }
                        ],
                        "label": "Type",
                        "dataType": "picklist",
                        "filterable": true
                    },
        }
...
    },
    "reportExtendedMetadata": {
        "detailColumnInfo": {
            "OPPORTUNITY_NAME": {
                "label": "Opportunity Name",
                "dataType": "string"
            },
            "PROBABILITY": {
                "label": "Probability (%)",
                "dataType": "percent"
            },
            "EXP_AMOUNT": {
                "label": "Expected Revenue",
                "dataType": "currency"
            },
            "NEXT_STEP": {
                "label": "Next Step",
                "dataType": "string"
            },
            "BucketField_34840671": {
                "label": "Industry",
                "dataType": "string"
            }
        },
        "aggregateColumnInfo": {
            "RowCount": {
                "label": "Record Count",
                "dataType": "int",
                "downGroupingContext": null,
                "acrossGroupingContext": null
            },
            "FORMULA1": {
                "label": "formula1",
                "dataType": "double",
                "downGroupingContext": "ALL_SUMMARY_LEVELS",
                "acrossGroupingContext": "ALL_SUMMARY_LEVELS"
            },
            "s!EXP_AMOUNT": {
                "label": "Sum of Expected Revenue",
                "dataType": "currency",
                "downGroupingContext": null,
                "acrossGroupingContext": null
            }
        },
        "groupingColumnInfo": {
            "CLOSE_DATE": {
                "label": "Close Date",
                "dataType": "date",
                "groupingLevel": 1
            },
            "STAGE_NAME": {
                "label": "Stage",
                "dataType": "picklist",
                "groupingLevel": 0
            },
            "ACCOUNT_NAME": {
                "label": "Account Name",
                "dataType": "string",
                "groupingLevel": 0
            },
            "ACCOUNT_LAST_ACTIVITY": {
                "label": "Account: Last Activity",
                "dataType": "date",
                "groupingLevel": 1
            }
        }
    },
    "reportMetadata": {
        "name": "Stuck Opportunities",
        "id": "00OD0000001ZbP7MAK",
        "currency": null,
        "developerName": "StuckOpportunities",
        "groupingsDown": [
            {
                "name": "ACCOUNT_NAME",
                "sortOrder": "Asc",
                "dateGranularity": "None"
            },
            {
                "name": "CLOSE_DATE",
                "sortOrder": "Desc",
                "dateGranularity": "FiscalQuarter"
            }
        ],
        "groupingsAcross": [
            {
                "name": "STAGE_NAME",
                "sortOrder": "Desc",
                "dateGranularity": "None"
            },
            {
                "name": "ACCOUNT_LAST_ACTIVITY",
                "sortOrder": "Asc",
                "dateGranularity": "Week"
            }
        ],
        "reportType": {
            "type": "Opportunity",
            "label": "Opportunities"
        },
        "aggregates": [
            "s!EXP_AMOUNT",
            "FORMULA1",
            "RowCount"
        ],
        "reportFormat": "MATRIX",
        "reportBooleanFilter": null,
        "reportFilters": [
            {
                "value": "Closed Won,Closed Lost",
                "column": "STAGE_NAME",
                "operator": "notEqual"
            },
            {
                "value": "50",
                "column": "PROBABILITY",
                "operator": "greaterThan"
            }
        ],
        "detailColumns": [
            "OPPORTUNITY_NAME",
            "PROBABILITY",
            "EXP_AMOUNT",
            "NEXT_STEP",
            "BucketField_34840671"
        ]
    }
}
```

**See Also**  


-   [Describe](https://developer.salesforce.com/docs/analytics/reference/reports/sforce-analytics-rest-api-getbasic-reportmetadata.md)