Get summary data with or without details by running a report synchronously or asynchronously through the API. When you run a report, the API returns data for the same number of records that are available when the report is run in the Salesforce user interface.
Run a report synchronously if you expect it to finish running quickly. Otherwise, we recommend that you run reports through the API asynchronously for these reasons:
Long running reports have a lower risk of reaching the timeout limit when run asynchronously.
The 2-minute overall Salesforce API timeout limit doesn’t apply to asynchronous runs.
The Salesforce Reports and Dashboards REST API can handle a higher number of asynchronous run requests at a time.
Since the results of an asynchronously run report are stored for a 24-hr rolling period, they’re available for recurring access.
To run a report synchronously:
To fetch report data asynchronously:
Send a POST request to the Execute Async resource. If you’re passing filters, include them in the POST request metadata. The request returns the instance ID where results of the run are stored.
Send a GET request to the Instance Results resource to fetch data using the instance ID.
This GET request to the Execute Sync resource, /services/data/v35.0/analytics/reports/00OR0000000K2UeMAK?includeDetails=true, for a synchronous run returns summary data with details.
1{
2 "attributes" : {
3 "describeUrl" :
4 "/services/data/v35.0/analytics/reports/00OR0000000K2UeMAK/describe",
5 "instancesUrl" :
6 "/services/data/v35.0/analytics/reports/00OR0000000K2UeMAK/instances",
7 "reportId" :
8 "00OR0000000K2UeMAK",
9 "reportName" : "Deals Closing This Quarter",
10 "type" : "Report"
11 },
12 "allData" : true,
13 "factMap" : {
14 "2!0_0" : {
15 "aggregates" : [
16 { "label" : "$16,000.01", "value" : 16000.010000000000218278728425502777099609375 },
17 { "label" : "$16,000.01", "value" : 16000.010000000000218278728425502777099609375 },
18 { "label" : "1", "value" : 1 } ],
19 "rows" : [ {
20 "dataCells" : [
21 { "label" : "Acme - 200 Widgets", "value" : "006R00000023IDYIA2" },
22 { "label" : "$16,000.01",
23 "value" : { "amount" : 16000.01, "currency" : null } },
24 { "label" : "Word of mouth", "value" : "Word of mouth" },
25 { "label" : "Need estimate", "value" : "Need estimate" },
26 { "label" : "60%", "value" : 60},
27 { "label" : "Q3-2015", "value" : "Q3-2015" },
28 { "label" : "12", "value" : 12 },
29 { "label" : "7/31/2015", "value" : "2015-07-31" },
30 { "label" : "Fred Wiliamson", "value" : "005R0000000Hv5rIAC" },
31 { "label" : "-", "value" : null } ]
32 } ]
33 },
34 "T!0" : {
35 "aggregates" : [
36 { "label" : "$32,021.01", "value" : 32021.00999999999839928932487964630126953125 },
37 { "label" : "$16,010.51", "value" : 16010.504999999999199644662439823150634765625 },
38 { "label" : "2", "value" : 2 } ],
39 "rows" : [ ]
40 },
41...
42 "T!T" : {
43 "aggregates" : [
44 { "label" : "$153,042.01", "value" : 153042.01000000000931322574615478515625 },
45 { "label" : "$25,507.00", "value" : 25507.00166666666700621135532855987548828125 },
46 { "label" : "6", "value" : 6 } ],
47 "rows" : [ ]
48 },
49...
50 "groupingsAcross" : {
51 "groupings" : [
52 {
53 "groupings" : [
54 { "groupings" : [ ], "key" : "0_0", "label" : "Existing Business", "value" : "Existing Business" } ],
55 "key" : "0",
56 "label" : "July 2015",
57 "value" : "2015-07-01"
58 },
59 {
60 "groupings" : [
61 { "groupings" : [ ], "key" : "1_0", "label" : "Existing Business", "value" : "Existing Business" },
62 { "groupings" : [ ], "key" : "1_1", "label" : "New Business", "value" : "New Business" } ],
63 "key" : "1",
64 "label" : "August 2015",
65 "value" : "2015-08-01"
66 },
67 {
68 "groupings" : [
69 { "groupings" : [ ], "key" : "2_0", "label" : "Existing Business", "value" : "Existing Business" } ],
70 "key" : "2",
71 "label" : "September 2015",
72 "value" : "2015-09-01"
73 }
74 ]
75 },
76 "groupingsDown" : {
77 "groupings" : [
78 { "groupings" : [ ], "key" : "0", "label" : "Acme", "value" : "001R0000002GuzsIAC" },
79 { "groupings" : [ ], "key" : "1", "label" : "Facebook", "value" : "001R0000001nUAmIAM" },
80 { "groupings" : [ ], "key" : "2", "label" : "Home Depot", "value" : "001R0000002Gv5zIAC" },
81 { "groupings" : [ ], "key" : "3", "label" : "Mircosoft", "value" : "001R0000002Gv5QIAS" } ]
82 },
83 "hasDetailRows" : true,
84 "reportExtendedMetadata" : {
85 "aggregateColumnInfo" : {
86 "s!AMOUNT" : {
87 "acrossGroupingContext" : null,
88 "dataType" : "currency",
89 "downGroupingContext" : null,
90 "label" : "Sum of Amount" },
91 "a!AMOUNT" : {
92 "acrossGroupingContext" : null,
93 "dataType" : "currency",
94 "downGroupingContext" : null,
95 "label" : "Average Amount" },
96 "RowCount" : {
97 "acrossGroupingContext" : null,
98 "dataType" : "int",
99 "downGroupingContext" : null,
100 "label" : "Record Count" }
101 },
102 "detailColumnInfo" : {
103 "OPPORTUNITY_NAME" : { "dataType" : "string", "label" : "Opportunity Name" },
104 "AMOUNT" : { "dataType" : "currency", "label" : "Amount" },
105 "LEAD_SOURCE" : { "dataType" : "picklist", "label" : "Lead Source" },
106 "NEXT_STEP" : { "dataType" : "string", "label" : "Next Step" },
107 "PROBABILITY" : { "dataType" : "percent", "label" : "Probability (%)" },
108 "FISCAL_QUARTER" : { "dataType" : "string", "label" : "Fiscal Period" },
109 "AGE" : { "dataType" : "int", "label" : "Age" },
110 "CREATED_DATE" : { "dataType" : "datetime", "label" : "Created Date" },
111 "FULL_NAME" : { "dataType" : "string", "label" : "Opportunity Owner" },
112 "ROLLUP_DESCRIPTION" : { "dataType" : "string", "label" : "Owner Role" }
113 },
114 "groupingColumnInfo" : {
115 "ACCOUNT_NAME" : { "dataType" : "string", "groupingLevel" : 0, "label" : "Account Name" },
116 "CLOSE_DATE" : { "dataType" : "date", "groupingLevel" : 0, "label" : "Close Date" },
117 "TYPE" : { "dataType" : "picklist", "groupingLevel" : 1, "label" : "Type" }
118 }
119 },
120 "reportMetadata" : {
121 "aggregates" : [ "s!AMOUNT", "a!AMOUNT", "RowCount" ],
122 "chart" : {
123 "chartType" : "Donut",
124 "groupings" : [ "CLOSE_DATE" ],
125 "hasLegend" : true,
126 "showChartValues" : false,
127 "summaries" : [ "s!AMOUNT" ],
128 "summaryAxisLocations" : [ "Y" ],
129 "title" : "Pipeline by Stage and Type"
130 },
131 "currency" : null,
132 "description" : null,
133 "detailColumns" : [ "OPPORTUNITY_NAME", "AMOUNT", "LEAD_SOURCE","NEXT_STEP",
134 "PROBABILITY", "FISCAL_QUARTER", "AGE", "CREATED_DATE", "FULL_NAME", "ROLLUP_DESCRIPTION" ],
135 "developerName" : "Deals_Closing_This_Quarter",
136 "division" : null,
137 "folderId" : "00lR0000000M8IiIAK",
138 "groupingsAcross" : [
139 { "dateGranularity" : "Month", "name" : "CLOSE_DATE", "sortAggregate" : null, "sortOrder" : "Asc"},
140 { "dateGranularity" : "None", "name" : "TYPE", "sortAggregate" : null, "sortOrder" : "Asc" } ],
141 "groupingsDown" : [
142 { "dateGranularity" : "None", "name" : "ACCOUNT_NAME", "sortAggregate" : null, "sortOrder" : "Asc" } ],
143 "hasDetailRows" : true,
144 "hasRecordCount" : true,
145 "historicalSnapshotDates" : [ ],
146 "id" : "00OR0000000K2UeMAK",
147 "name" : "Deals Closing This Quarter",
148 "reportBooleanFilter" : null,
149 "reportFilters" : [
150 { "column" : "BucketField_36625466", "isRunPageEditable" : true, "operator" : "equals", "value" : "Early,Late" },
151 { "column" : "TYPE", "isRunPageEditable" : true, "operator" : "equals", "value" : "Existing Business,New Business" } ],
152 "reportFormat" : "MATRIX",
153 "reportType" : { "label" : "Opportunities", "type" : "Opportunity" },
154 "scope" : "organization",
155 "showGrandTotal" : true,
156 "showSubtotals" : true,
157 "sortBy" : [ ],
158 "standardDateFilter" : {
159 "column" : "CLOSE_DATE",
160 "durationValue" : "THIS_FISCAL_QUARTER",
161 "endDate" : "2015-09-30",
162 "startDate" : "2015-07-01" },
163 "standardFilters" : [
164 { "name" : "open", "value" : "all" },
165 { "name" : "probability", "value" : ">0" } ]
166 }
167}This is a POST request (an empty request body), /services/data/v35.0/analytics/reports/00OR0000000K2UeMAK/instances, to the Execute Async resource for an asynchronous run requesting summary results.
1{}The response to the POST request returns the instance handle that stores the summary results of the run.
1{
2 "completionDate" : null,
3 "hasDetailRows" : true,
4 "id" : "0LGR00000000He3OAE",
5 "ownerId" : "005R0000000Hv5rIAC",
6 "queryable" : false,
7 "requestDate" : "2015-08-12T16:05:43Z",
8 "status" : "New",
9 "url" : "/services/data/v35.0/analytics/reports/00OR0000000K2UeMAK/instances/0LGR00000000He3OAE"
10}A GET request, /services/data/v35.0/analytics/reports/00OR0000000K2UeMAK/instances/0LGR00000000He3OAE, to the Instance Results resource for the instance handle fetches the report results.
1{
2 "attributes" : {
3 "completionDate" : "2015-08-12T16:05:44Z",
4 "id" : "0LGR00000000He3OAE",
5 "ownerId" : "005R0000000Hv5rIAC",
6 "queryable" : false,
7 "reportId" : "00OR0000000K2UeMAK",
8 "reportName" : "Deals Closing This Quarter",
9 "requestDate" : "2015-08-12T16:05:43Z",
10 "status" : "Success",
11 "type" : "ReportInstance" },
12 "allData" : true,
13 "factMap" : {
14 "2!0_0" : {
15 "aggregates" : [
16 { "label" : "$16,000.01", "value" : 16000.010000000000218278728425502777099609375 },
17 { "label" : "$16,000.01", "value" : 16000.010000000000218278728425502777099609375 },
18 { "label" : "1", "value" : 1 } ],
19 "rows" : [ {
20 "dataCells" : [
21 { "label" : "Acme - 200 Widgets", "value" : "006R00000023IDYIA2" },
22 { "label" : "$16,000.01",
23 "value" : { "amount" : 16000.01,
24 "currency" : null } },
25 { "label" : "Word of mouth", "value" : "Word of mouth" },
26 { "label" : "Need estimate", "value" : "Need estimate" },
27 { "label" : "60%", "value" : 60 },
28 { "label" : "Q3-2015", "value" : "Q3-2015" },
29 { "label" : "12", "value" : 12 },
30 { "label" : "7/31/2015", "value" : "2015-07-31" },
31 { "label" : "Fred Wiliamson", "value" : "005R0000000Hv5rIAC" },
32 { "label" : "-", "value" : null } ]
33 } ]
34 },
35...
36 "groupingsAcross" : {
37 "groupings" : [
38...
39 ]
40 },
41 "groupingsDown" : {
42 "groupings" : [
43...
44 ]
45 },
46 "hasDetailRows" : true,
47 "reportExtendedMetadata" : {
48 "aggregateColumnInfo" : {
49 "s!AMOUNT" : {
50 "acrossGroupingContext" : null,
51 "dataType" : "currency",
52 "downGroupingContext" : null,
53 "label" : "Sum of Amount" },
54 "a!AMOUNT" : {
55 "acrossGroupingContext" : null,
56 "dataType" : "currency",
57 "downGroupingContext" : null,
58 "label" : "Average Amount" },
59 "RowCount" : {
60 "acrossGroupingContext" : null,
61 "dataType" : "int",
62 "downGroupingContext" : null,
63 "label" : "Record Count" }
64 },
65 "detailColumnInfo" :
66 { "OPPORTUNITY_NAME" : { "dataType" : "string", "label" : "Opportunity Name" },
67 "AMOUNT" : { "dataType" : "currency", "label" : "Amount"},
68 "LEAD_SOURCE" : { "dataType" : "picklist", "label" : "Lead Source" },
69 "NEXT_STEP" : { "dataType" : "string", "label" : "Next Step" },
70 "PROBABILITY" : { "dataType" : "percent", "label" : "Probability (%)" },
71 "FISCAL_QUARTER" : { "dataType" : "string", "label" : "Fiscal Period" },
72 "AGE" : { "dataType" : "int", "label" : "Age" },
73 "CREATED_DATE" : { "dataType" : "datetime", "label" : "Created Date" },
74 "FULL_NAME" : { "dataType" : "string", "label" : "Opportunity Owner" },
75 "ROLLUP_DESCRIPTION" : { "dataType" : "string", "label" : "Owner Role" } },
76 "groupingColumnInfo" : {
77 "ACCOUNT_NAME" : { "dataType" : "string", "groupingLevel" : 0, "label" : "Account Name" },
78 "CLOSE_DATE" : { "dataType" : "date", "groupingLevel" : 0, "label" : "Close Date" },
79 "TYPE" : { "dataType" : "picklist", "groupingLevel" : 1, "label" : "Type" }}
80 },
81 "reportMetadata" : {
82 "aggregates" : [ "s!AMOUNT", "a!AMOUNT", "RowCount" ],
83 "chart" : {
84 "chartType" : "Donut",
85 "groupings" : [ "CLOSE_DATE" ],
86 "hasLegend" : true,
87 "showChartValues" : false,
88 "summaries" : [ "s!AMOUNT" ],
89 "summaryAxisLocations" : [ "Y" ],
90 "title" : "Pipeline by Stage and Type" },
91 "currency" : null,
92 "description" : null,
93 "detailColumns" : [ "OPPORTUNITY_NAME", "AMOUNT", "LEAD_SOURCE", "NEXT_STEP", "PROBABILITY",
94 "FISCAL_QUARTER", "AGE", "CREATED_DATE", "FULL_NAME", "ROLLUP_DESCRIPTION" ],
95 "developerName" : "Deals_Closing_This_Quarter",
96 "division" : null,
97 "folderId" : "00lR0000000M8IiIAK",
98 "groupingsAcross" : [
99 { "dateGranularity" : "Month", "name" : "CLOSE_DATE", "sortAggregate" : null, "sortOrder" : "Asc" },
100 { "dateGranularity" : "None", "name" : "TYPE", "sortAggregate" : null, "sortOrder" : "Asc" } ],
101 "groupingsDown" : [
102 { "dateGranularity" : "None", "name" : "ACCOUNT_NAME", "sortAggregate" : null, "sortOrder" : "Asc" } ],
103 "hasDetailRows" : true,
104 "hasRecordCount" : true,
105 "historicalSnapshotDates" : [ ],
106 "id" : "00OR0000000K2UeMAK",
107 "name" : "Deals Closing This Quarter",
108 "reportBooleanFilter" : null,
109 "reportFilters" : [
110 { "column" : "BucketField_36625466", "isRunPageEditable" : false, "operator" : "equals", "value" : "Early,Late" },
111 { "column" : "TYPE", "isRunPageEditable" : false, "operator" : "equals", "value" : "Existing Business,New Business" } ],
112 "reportFormat" : "MATRIX",
113 "reportType" : { "label" : "Opportunities", "type" : "Opportunity" },
114 "scope" : "organization",
115 "showGrandTotal" : true,
116 "showSubtotals" : true,
117 "sortBy" : [ ],
118 "standardDateFilter" : {
119 "column" : "CLOSE_DATE",
120 "durationValue" : "THIS_FISCAL_QUARTER",
121 "endDate" : "2015-09-30",
122 "startDate" : "2015-07-01" },
123 "standardFilters" : [
124 { "name" : "open", "value" : "all" },
125 { "name" : "probability", "value" : ">0" } ]
126 }
127}See Also
j