Execute Async

Determines 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.

• An empty array for reports in summary format as it can’t have column groupings.
• BucketField_(ID) for bucket fields.
• ID of a custom field when the custom field is used for a column grouping.

• BucketField_(ID) for bucket fields.
• ID of a custom field when the custom field is used for grouping.

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.”

{
...
        "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"
            }
        ]
    }
}

• TABULAR
• SUMMARY
• MATRIX
• MULTI_BLOCK

The MULTI_BLOCK property is available in API version 43.0 and later.

type: Of type string, this is the unique identifier of the report type.

label: Of type string, this is the display name of the report type.

Example:

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

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.

endDate: End date.

If specified, a role hierarchy filter is applied to the report. If unspecified, no role hierarchy filter is applied to the report.

• New if the report run has just been triggered through a request.
• Success if the report ran.
• Running if the report is being run.
• Error if the report run failed. The instance of a report run can return an error if, for example, your permission to access the report has been removed since you requested the run.

• When false, indicates that summary level data was requested for the report instance.
• When true, indicates that detailed data, which includes summary level data, was requested for the report instance.