Skip Navigation

Newer Version Available

This content describes an older version of this product. View Latest

Execute Async

Resource URL

Runs an instance of a report asynchronously with or without filters and returns a handle that stores the results of the run. The results can contain summary data with or without details.

Data	URL
Summary
Summary with detail

Formats

JSON

HTTP methods

POST

POST request body

Property	Type	Description
`name`	String	Report name.
`id`	String	Unique report ID.
`currency`	String	Report 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.
`reportFormat`	String	Format of the report. Value can be: `TABULAR` `SUMMARY` `MATRIX`
`developerName`	String	Report API name.
`reportType`	Report type	Unique API name and display name for the report type. `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.
`aggregates`	Array of strings	Unique identities for summary or custom summary formula fields in the report. For example: 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.
`groupingsDown`	Groupings down[]	Unique identities for each row grouping in a report. The identity is: `BucketField_(ID)` for bucket fields. ID of a custom field when the custom field is used for grouping.
`groupingsAcross`	Groupings 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. ID of a custom field when the custom field is used for a column grouping.
`reportBooleanFilter`	String	Logic to parse custom field filters. Value is `null` when filter logic is not specified. 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.”
`reportFilters`	Filter details[]	List of each custom filter in the report along with the field name, filter operator, and filter value.
`detailColumns`	Array of strings	Unique API names for the fields that have detailed data.
`historicalSnapshotDates`	Array of strings	List of historical snapshot dates.

Response body

Property	Type	Description
`id`	String	Unique ID for an instance of a report that was run asynchronously.
`status`	String	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.
`url`	String	URL where results of the report run for that instance are stored. The value is `null` if the report couldn’t be run because of an error.
`ownerId`	String	API name for the user ID.
`completionDate`	Date, time string	Date, time when the instance of the report run finished. Only available if the report instance ran successfully or couldn’t be run because of an error. Date-time information is in ISO-8601 format.
`hasDetailRows`	Boolean	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.
`requestDate`	Date, time string	Date and time when an instance of the report run was requested. Date-time information is in ISO-8601 format.

Examples

See a sample of a GET request to return a list of asynchronous runs of a report.
See a sample of a POST request to request an asynchronous report run.