Execute Sync

Resource URL

Runs a report immediately with or without changing filters, groupings, or aggregates and returns the latest summary data with or without details for your level of access.

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

Formats

JSON

HTTP Methods

POST Request Body

{
...
        "reportBooleanFilter": "(1 OR 2) AND 3",
        "reportFilters": [
            {
                "value": "Analyst,Integrator,Press,Other",
                "column": "TYPE",
                "operator": "notEqual"
            },
            {
                "value": "100,000",
                "column": "SALES",
                "operator": "greaterThan"
            },
            {
                "value": "Small",
                "column": "Size",
                "operator": "notEqual"
            }
        ]
    }
}

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

Response Body

Attributes

Property	Type	Description
describeUrl	String	Resource URL to get report metadata.
instancesUrl	String	Resource URL to run a report asynchronously. The report can be run with or without filters to get summary or both summary and detailed data. Results of each instance of the report run are stored under this URL.
type	String	API resource format.
reportName	String	Display name of the report.
reportId	String	Unique report ID.

Fact map

Property	Type	Description
rows	Data cells[]	Array of detailed report data listed in the order of the detail columns provided by the report metadata.
aggregates	Aggregates[]	Summary level data including record count for a report.

Data cells

Property	Type	Description
value	Detail column info data type	The value of a specified cell. If the response is an empty string, then API version 36.0 and earlier returns null. API version 37.0 and later returns an empty string.
label	String	Display name of the value as it appears for a specified cell in the report.

Aggregates

Property	Type	Description
value	Number	Numeric value of the summary data for a specified cell.
label	String	Formatted summary data for a specified cell.

Groupings across

Property	Type	Description
groupings	Groupings[]	Information for each column grouping as a list.

Groupings

Property	Type	Description
value	String	Value of the field used as a row or column grouping. The value depends on the field’s data type. Currency fields: amount: Of type currency. Value of a data cell. currency: Of type picklist. The ISO 4217 currency code, if available; for example, USD for US dollars or CNY for Chinese yuan. (If the grouping is on the converted currency, this is the currency code for the report and not for the record.) Picklist fields: API name. For example, a custom picklist field, Type of Business with values 1, 2, 3 for Consulting, Services, and Add-On Business, has 1, 2, or 3 as the grouping value. ID fields: API name. Record type fields: API name. Date and time fields: Date or time in ISO-8601 format. Lookup fields: Unique API name. For example, for the Opportunity Owner lookup field, the ID of each opportunity owner’s Chatter profile page can be a grouping value.
key	String	Unique identity for a row or column grouping. The identity is used by the fact map to specify data values within each grouping.
label	String	Display name of a row or column grouping. For date and time fields, the label is the localized date or time.
groupings	Array	Second or third level row or column groupings. If there are none, the value is an empty array.
dategroupings	Array	Start date and end date of the interval defined by date granularity.

Groupings down

Property	Type	Description
groupings	Groupings[]	Information for each row grouping as a list.