Execute Async
Resource URL
/services/data/<latest API version>/analytics/reports/<report ID>/instances
Formats
JSON
HTTP Methods
Method | Description |
---|---|
POST | Runs an instance of a report asynchronously. See this example. Also see this example of a GET request that returns a list of asynchronous runs of a report. |
POST Request Body
Property | Type | Description |
---|---|---|
aggregates | Array of strings |
Unique identities for summary or
custom summary formula fields in the report. For example:
|
allowedInCustomDetailFormula | Boolean | Specifies whether a field can be referenced in a row-level formula (true) or not (false). |
buckets | Bucket field | Describes a bucket field. |
chart | Chart[] | Details about the chart used in a report. |
crossFilters | Cross filter[] | Cross filters applied to the report. |
customDetailFormula | Custom Detail Formula[] | An array of objects that describes row-level formulas. |
customSummaryFormula | Custom summary formula | Describes a custom summary formulas. |
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. |
dashboardSetting | Name/value pair | Allows saving of dashboard settings to allow for reports with row limit filters on dashboards. Can be configured on a report for Top-N reports. The Name and Value fields in dashboardSetting are used as Grouping and Aggregate in dashboard components. |
detailColumns | Array of strings | Unique API names for the fields that have detailed data. |
developerName | String | Report API name. |
division | String |
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. |
folderId | String | ID of the folder that contains the report. |
groupingsAcross | Groupings across[] | Unique identities for each column grouping in a
report. The identity is:
|
groupingsDown | Groupings down[] | Unique identities for each row grouping in a report.
The identity is:
|
hasDetailRows | Boolean | Indicates whether to include detailed data with the summary data. |
hasRecordCount | Boolean | Indicates whether the report shows the record count. |
historicalSnapshotDates | Array of strings | List of historical snapshot dates. |
id | String | Unique report ID. |
name | String | Display name of the report. |
presentationOptions | Report presentation options | Display options in the Lightning Report Builder. |
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. |
reportFormat | String | Format of the report. Possible values are:
The MULTI_BLOCK property is available in API version 43.0 and later. |
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. |
scope | String | Defines the scope of the data on which you run the report. For example, you can run the report against all opportunities, opportunities you own, or opportunities your team owns. Valid values depend on the report type. |
showGrandTotal | Boolean | Indicates whether the report shows the grand total. |
showSubtotals | Boolean | Indicates whether the report shows subtotals, such as column or row totals. |
sortBy | Array of strings | API name of the field on which the report is sorted
and the direction of the sort (asc or
desc). Example:
|
standardDateFilter | Array of strings | Standard date filters available in reports. Each
standard date filter contains the following
properties: 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. |
standardFilters | Array of strings | List of filters that show up in the report by default. The filters vary by report type. For example, standard filters for reports on the Opportunity object are Show, Opportunity Status, and Probability. This list appears as name-value string pairs. |
supportsRoleHierarchy | Boolean | Indicates whether the report type supports role hierarchy filtering (true) or not (false). |
topRows | Top rows | Describes a row limit filter applied to the report. |
userOrHierarchyFilterId | String | Unique user or role ID of the user or role used by
the report's role hierarchy filter. If specified, a role hierarchy filter is applied to the report. If unspecified, no role hierarchy filter is applied to the report. |
Response Body
Property | Type | Description |
---|---|---|
id | String | Unique ID for an instance of a report that was run asynchronously. |
status | String |
|
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 of the user that created the instance. |
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 |
|
requestDate | Date, time string | Date and time when an instance of the report run was requested. Date-time information is in ISO-8601 format. |