Salesforce Reports And Dashboards REST API Developer Guide
User Manual:
Open the PDF directly: View PDF 
.
Page Count: 228
| Download | |
| Open PDF In Browser | View PDF |
Salesforce Reports and
Dashboards REST API
Developer Guide
Version 39.0, Spring ’17
@salesforcedocs
Last updated: March 10, 2017
© Copyright 2000–2017 salesforce.com, inc. All rights reserved. Salesforce is a registered trademark of salesforce.com, inc.,
as are other names and marks. Other marks appearing herein may be trademarks of their respective owners.
CONTENTS
Chapter 1: Salesforce Reports and Dashboards REST API . . . . . . . . . . . . . . . . . . . . . . . 1
Requirements and Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Chapter 2: Examples: Reports REST API Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Create a New Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Run Reports Synchronously or Asynchronously . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Get Report Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Get a List of Report Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
List Asynchronous Runs of a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Filter Reports on Demand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
List Recently Viewed Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Decode the Fact Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Get Report Data without Saving Changes to or Creating a Report . . . . . . . . . . . . . . . . . . . . . 59
Save Changes to Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Clone Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Delete Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Chapter 3: Examples: Dashboards REST API Resources . . . . . . . . . . . . . . . . . . . . . . . 74
Get List of Recently Used Dashboards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Get Dashboard Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Filter Dashboard Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Get Dashboard Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Refresh a Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Save a Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Return Details About Dashboard Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Get Dashboard Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Clone a Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Delete a Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Chapter 4: Examples: Analytics Notifications REST API . . . . . . . . . . . . . . . . . . . . . . . . 110
Get Analytics Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Create an Analytics Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Save Changes to an Analytics Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Delete an Analytics Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Check Limits for Analytics Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Chapter 5: Reports API Resource Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Describe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Execute Sync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Contents
Execute Async . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Instances List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Instance Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Report List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Report Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Chapter 6: Report Types API Resource Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Report Type List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Report Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Chapter 7: Dashboards API Resource Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Dashboard List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Dashboard Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Dashboard Describe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Dashboard Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Dashboard and Component Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Chapter 8: Analytics Notifications API Resource Reference . . . . . . . . . . . . . . . . . . . . 211
Analytics Notification List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Analytics Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Analytics Notification Limits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
INDEX
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
CHAPTER 1
In this chapter ...
•
Requirements and
Limitations
Salesforce Reports and Dashboards REST API
The Reports and Dashboards REST API gives you programmatic access to your report and dashboard
data as defined in the report builder and dashboard builder. The API lets you integrate the data into any
web or mobile application, inside or outside the Salesforce platform. For example, you might use the
API to trigger a Chatter post with a snapshot of top-performing reps each quarter.
The Reports and Dashboards REST API will revolutionize the way you access and visualize your data. You
can:
• Integrate report data into custom objects.
• Define rich visualizations on top of the API to animate the data.
• Build custom dashboards.
• Automate reporting tasks.
At a high level, the API resources let you query and filter report data. You can:
• Run tabular, summary, or matrix reports synchronously or asynchronously.
• Filter for specific data on the fly.
• Query report metadata.
You can also work with dashboard resources to:
• Get a list of recently used dashboards.
• Get dashboard metadata and data.
• Query dashboard status.
• Refresh dashboards.
1
Salesforce Reports and Dashboards REST API
Requirements and Limitations
Requirements and Limitations
The Reports and Dashboards REST API is available for any organization that has API enabled. You must establish an authenticated session
using OAuth in order to access the Reports and Dashboards REST API. When working with this API, consider these restrictions in addition
to general API limits.
Note: Responses and requests are in JSON. While using the Reports and Dashboards REST API with a POST request body, you
must use content-type: application/json. You might get unexpected results if you don’t use this content type.
Reports Limits
• Cross filters, standard report filters, and filtering by row limit are unavailable when filtering data.
• Historical trend reports are only supported for matrix reports.
• The API can process only reports that contain up to 100 fields selected as columns.
• A list of up to 200 recently viewed reports can be returned.
• Your org can request up to 500 synchronous report runs per hour.
• The API supports up to 20 synchronous report run requests at a time.
• A list of up to 2,000 instances of a report that was run asynchronously can be returned.
• The API supports up to 200 requests at a time to get results of asynchronous report runs.
• Your organization can request up to 1,200 asynchronous requests per hour.
• Asynchronous report run results are available within a 24-hour rolling period.
• The API returns up to the first 2,000 report rows. You can narrow results using filters.
• You can add up to 20 custom field filters when you run a report.
Dashboards Limits
• Your org can request up to 200 dashboard refreshes per hour.
• Your org can request results for up to 5,000 dashboards per hour.
Analytics Notification Limits
• Each user can subscribe to up to 5 reports.
• Each user can create up to 5 Wave notifications.
Note: All limits that apply to reports created in the report builder also apply to the API, as do limits for dashboards created in the
dashboard builder. For more information, see “Salesforce Reports and Dashboards Limits” in the Salesforce online help.
2
CHAPTER 2
In this chapter ...
•
Create a New Report
•
Run Reports
Synchronously or
Asynchronously
•
Get Report Metadata
•
Get a List of Report
Types
•
List Asynchronous
Runs of a Report
•
Filter Reports on
Demand
•
List Recently Viewed
Reports
•
Decode the Fact Map
•
Get Report Data
without Saving
Changes to or
Creating a Report
•
Save Changes to
Reports
•
Clone Reports
•
Delete Reports
Examples: Reports REST API Resources
The Reports and Dashboards REST API is designed to let you query report data easily. Use the API to:
• Run Reports Synchronously or Asynchronously.
Run a report immediately or asynchronously to get summary data with or without details. We
recommend that you run reports asynchronously to avoid report timeouts and other API limits.
• Get Report Metadata.
Get information about fields in the report and report type. This includes information about fields
used for report groupings, summaries, detailed data, and filters.
• List Asynchronous Runs of a Report.
Get a list of all instances of a report run asynchronously.
• Filter Reports on Demand.
Get specific data back by running a report with filter changes in the metadata.
• List Recently Viewed Reports
Get most recently viewed reports that you have permission to access.
• Decode the Fact Map.
Get a visualized view of your report data.
• Save Changes to Reports
Save changes to reports.
• Clone Reports
Make copies of existing reports.
• Delete Reports
Clean up unused and obsolete reports.
3
Examples: Reports REST API Resources
Create a New Report
Create a New Report
Create a new report using a POST request.
Example Usage
/services/data/v39.0/analytics/reports
Example Request Body
To create a report, you only have to specify reportMetadata with a name and a reportType to create a new report. Other
properties are optional.
{
"reportMetadata": {
"name":"NewReport",
"reportType": {
"type" : "Opportunity"
}
}
}
Example Response Body
The response includes the new report’s reportExtendedMetadata, reportMetadata, and reportTypeMetadata.
{
"reportExtendedMetadata" : {
"aggregateColumnInfo" : {
"RowCount" : {
"dataType" : "int",
"label" : "Record Count"
}
},
"detailColumnInfo" : {
"ROLLUP_DESCRIPTION" : {
"dataType" : "string",
"label" : "Owner Role"
},
"FULL_NAME" : {
"dataType" : "string",
"label" : "Opportunity Owner"
},
"ACCOUNT_NAME" : {
"dataType" : "string",
"label" : "Account Name"
},
"OPPORTUNITY_NAME" : {
"dataType" : "string",
"label" : "Opportunity Name"
},
"STAGE_NAME" : {
"dataType" : "picklist",
"label" : "Stage"
},
"FISCAL_QUARTER" : {
"dataType" : "string",
"label" : "Fiscal Period"
4
Examples: Reports REST API Resources
Create a New Report
},
"AMOUNT" : {
"dataType" : "currency",
"label" : "Amount"
},
"PROBABILITY" : {
"dataType" : "percent",
"label" : "Probability (%)"
},
"AGE" : {
"dataType" : "int",
"label" : "Age"
},
"CLOSE_DATE" : {
"dataType" : "date",
"label" : "Close Date"
},
"CREATED_DATE" : {
"dataType" : "datetime",
"label" : "Created Date"
},
"NEXT_STEP" : {
"dataType" : "string",
"label" : "Next Step"
},
"LEAD_SOURCE" : {
"dataType" : "picklist",
"label" : "Lead Source"
},
"TYPE" : {
"dataType" : "picklist",
"label" : "Type"
}
},
"groupingColumnInfo" : { }
},
"reportMetadata" : {
"aggregates" : [ "RowCount" ],
"chart" : null,
"crossFilters" : [ ],
"currency" : null,
"description" : null,
"detailColumns" : [ "ROLLUP_DESCRIPTION", "FULL_NAME", "ACCOUNT_NAME",
"OPPORTUNITY_NAME", "STAGE_NAME", "FISCAL_QUARTER", "AMOUNT", "PROBABILITY", "AGE",
"CLOSE_DATE", "CREATED_DATE", "NEXT_STEP", "LEAD_SOURCE", "TYPE" ],
"developerName" : "DocTest2_mG",
"division" : null,
"folderId" : "005R0000000Kg8cIAC",
"groupingsAcross" : [ ],
"groupingsDown" : [ ],
"hasDetailRows" : true,
"hasRecordCount" : true,
"historicalSnapshotDates" : [ ],
"id" : "00OR0000000PYkiMAG",
5
Examples: Reports REST API Resources
Create a New Report
"name" : "DocTest2",
"reportBooleanFilter" : null,
"reportFilters" : [ ],
"reportFormat" : "TABULAR",
"reportType" : {
"label" : "Opportunities",
"type" : "Opportunity"
},
"scope" : "organization",
"showGrandTotal" : true,
"showSubtotals" : true,
"sortBy" : [ ],
"standardDateFilter" : {
"column" : "CLOSE_DATE",
"durationValue" : "THIS_FISCAL_QUARTER",
"endDate" : "2016-12-31",
"startDate" : "2016-10-01"
},
"standardFilters" : [ {
"name" : "open",
"value" : "all"
}, {
"name" : "probability",
"value" : ">0"
} ],
"supportsRoleHierarchy" : true,
"userOrHierarchyFilterId" : null
},
"reportTypeMetadata" : {
"categories" : [ {
"columns" : {
"CREATED" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Created By"
},
"CREATED_ALIAS" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Created Alias"
},
"LAST_UPDATE_BY" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Last Modified By"
},
"LAST_UPDATE_BY_ALIAS" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Last Modified Alias"
6
Examples: Reports REST API Resources
Create a New Report
},
"OPPORTUNITY_NAME" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Opportunity Name"
},
"TYPE" : {
"dataType" : "picklist",
"filterValues" : [ {
"label" : "Existing Business",
"name" : "Existing Business"
}, {
"label" : "New Business",
"name" : "New Business"
} ],
"filterable" : true,
"label" : "Type"
},
"LEAD_SOURCE" : {
"dataType" : "picklist",
"filterValues" : [ {
"label" : "Advertisement",
"name" : "Advertisement"
}, {
"label" : "Employee Referral",
"name" : "Employee Referral"
}, {
"label" : "External Referral",
"name" : "External Referral"
}, {
"label" : "Partner",
"name" : "Partner"
}, {
"label" : "Public Relations",
"name" : "Public Relations"
}, {
"label" : "Seminar - Internal",
"name" : "Seminar - Internal"
}, {
"label" : "Seminar - Partner",
"name" : "Seminar - Partner"
}, {
"label" : "Trade Show",
"name" : "Trade Show"
}, {
"label" : "Web",
"name" : "Web"
}, {
"label" : "Word of mouth",
"name" : "Word of mouth"
}, {
"label" : "Other",
"name" : "Other"
7
Examples: Reports REST API Resources
Create a New Report
} ],
"filterable" : true,
"label" : "Lead Source"
},
"PARTNER_NAME" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Primary Partner"
},
"AMOUNT" : {
"dataType" : "currency",
"filterValues" : [ ],
"filterable" : true,
"label" : "Amount"
},
"CLOSED" : {
"dataType" : "boolean",
"filterValues" : [ {
"label" : "True",
"name" : "True"
}, {
"label" : "False",
"name" : "False"
} ],
"filterable" : true,
"label" : "Closed"
},
"WON" : {
"dataType" : "boolean",
"filterValues" : [ {
"label" : "True",
"name" : "True"
}, {
"label" : "False",
"name" : "False"
} ],
"filterable" : true,
"label" : "Won"
},
"CLOSE_DATE" : {
"dataType" : "date",
"filterValues" : [ ],
"filterable" : true,
"label" : "Close Date"
},
"CLOSE_DATE2" : {
"dataType" : "date",
"filterValues" : [ ],
"filterable" : true,
"label" : "Close Date (2)"
},
"CLOSE_MONTH" : {
"dataType" : "date",
8
Examples: Reports REST API Resources
Create a New Report
"filterValues" : [ ],
"filterable" : true,
"label" : "Close Month"
},
"LAST_STAGE_CHANGE_DATE" : {
"dataType" : "datetime",
"filterValues" : [ ],
"filterable" : true,
"label" : "Last Stage Change Date"
},
"NEXT_STEP" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Next Step"
},
"STAGE_NAME" : {
"dataType" : "picklist",
"filterValues" : [ {
"label" : "Prospecting",
"name" : "Prospecting"
}, {
"label" : "Qualification",
"name" : "Qualification"
}, {
"label" : "Needs Analysis",
"name" : "Needs Analysis"
}, {
"label" : "Value Proposition",
"name" : "Value Proposition"
}, {
"label" : "Id. Decision Makers",
"name" : "Id. Decision Makers"
}, {
"label" : "Perception Analysis",
"name" : "Perception Analysis"
}, {
"label" : "Proposal/Price Quote",
"name" : "Proposal/Price Quote"
}, {
"label" : "Negotiation/Review",
"name" : "Negotiation/Review"
}, {
"label" : "Closed Won",
"name" : "Closed Won"
}, {
"label" : "Closed Lost",
"name" : "Closed Lost"
} ],
"filterable" : true,
"label" : "Stage"
},
"PROBABILITY" : {
"dataType" : "percent",
9
Examples: Reports REST API Resources
Create a New Report
"filterValues" : [ ],
"filterable" : true,
"label" : "Probability (%)"
},
"FISCAL_QUARTER" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Fiscal Period"
},
"FISCAL_YEAR" : {
"dataType" : "int",
"filterValues" : [ ],
"filterable" : true,
"label" : "Fiscal Year"
},
"AGE" : {
"dataType" : "int",
"filterValues" : [ ],
"filterable" : true,
"label" : "Age"
},
"STAGE_DURATION" : {
"dataType" : "int",
"filterValues" : [ ],
"filterable" : true,
"label" : "Stage Duration"
},
"FORECAST_CATEGORY" : {
"dataType" : "picklist",
"filterValues" : [ {
"label" : "Omitted",
"name" : "Omitted"
}, {
"label" : "Pipeline",
"name" : "Pipeline"
}, {
"label" : "Best Case",
"name" : "Best Case"
}, {
"label" : "Commit",
"name" : "Commit"
}, {
"label" : "Closed",
"name" : "Closed"
} ],
"filterable" : true,
"label" : "Forecast Category"
},
"OPPORTUNITY_ID" : {
"dataType" : "id",
"filterValues" : [ ],
"filterable" : true,
"label" : "Opportunity ID"
10
Examples: Reports REST API Resources
Create a New Report
},
"LAST_ACTIVITY" : {
"dataType" : "date",
"filterValues" : [ ],
"filterable" : true,
"label" : "Last Activity"
},
"DESCRIPTION" : {
"dataType" : "textarea",
"filterValues" : [ ],
"filterable" : true,
"label" : "Description"
},
"HASOPPLINEITEM" : {
"dataType" : "boolean",
"filterValues" : [ {
"label" : "True",
"name" : "True"
}, {
"label" : "False",
"name" : "False"
} ],
"filterable" : true,
"label" : "Has Products"
},
"CREATED_DATE" : {
"dataType" : "datetime",
"filterValues" : [ ],
"filterable" : true,
"label" : "Created Date"
},
"LAST_UPDATE" : {
"dataType" : "datetime",
"filterValues" : [ ],
"filterable" : true,
"label" : "Last Modified Date"
}
},
"label" : "Opportunity Information"
}, {
"columns" : {
"FULL_NAME" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Opportunity Owner"
},
"ROLLUP_DESCRIPTION" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Owner Role"
},
"ALIAS" : {
11
Examples: Reports REST API Resources
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Opportunity
},
"OWNER_EMAIL" : {
"dataType" : "email",
"filterValues" : [ ],
"filterable" : true,
"label" : "Opportunity
},
"OWNER_PHONE" : {
"dataType" : "phone",
"filterValues" : [ ],
"filterable" : true,
"label" : "Opportunity
},
"OWNER_MOBILE_PHONE" : {
"dataType" : "phone",
"filterValues" : [ ],
"filterable" : true,
"label" : "Opportunity
},
"OWNER_MANAGER" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Opportunity
},
"OWNER_TITLE" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Opportunity
},
"OWNER_COMPANY" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Opportunity
},
"OWNER_DEPARTMENT" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Opportunity
},
"OWNER_DIVISION" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Opportunity
},
"OWNER_PROFILE" : {
Create a New Report
Owner Alias"
Owner Email"
Owner: Phone"
Owner: Mobile Phone"
Owner: Manager"
Owner: Title"
Owner: Company"
Owner: Department"
Owner: Division"
12
Examples: Reports REST API Resources
Create a New Report
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Opportunity Owner: Profile"
},
"OWNER_ACTIVE" : {
"dataType" : "boolean",
"filterValues" : [ {
"label" : "True",
"name" : "True"
}, {
"label" : "False",
"name" : "False"
} ],
"filterable" : true,
"label" : "Opportunity Owner: Active"
}
},
"label" : "Opportunity Owner Information"
}, {
"columns" : {
"ACCOUNT_NAME" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Account Name"
},
"ACCOUNT_OWNER" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Account Owner"
},
"ACCOUNT_OWNER_ALIAS" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Account Owner Alias"
},
"PARENT_NAME" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Parent Account"
},
"PARENT_ID" : {
"dataType" : "id",
"filterValues" : [ ],
"filterable" : true,
"label" : "Parent Account ID"
},
"SALES" : {
"dataType" : "currency",
"filterValues" : [ ],
13
Examples: Reports REST API Resources
Create a New Report
"filterable" : true,
"label" : "Annual Revenue"
},
"ACCOUNT_TYPE" : {
"dataType" : "picklist",
"filterValues" : [ {
"label" : "Analyst",
"name" : "Analyst"
}, {
"label" : "Competitor",
"name" : "Competitor"
}, {
"label" : "Customer",
"name" : "Customer"
}, {
"label" : "Integrator",
"name" : "Integrator"
}, {
"label" : "Investor",
"name" : "Investor"
}, {
"label" : "Partner",
"name" : "Partner"
}, {
"label" : "Press",
"name" : "Press"
}, {
"label" : "Prospect",
"name" : "Prospect"
}, {
"label" : "Reseller",
"name" : "Reseller"
}, {
"label" : "Other",
"name" : "Other"
} ],
"filterable" : true,
"label" : "Account Type"
},
"INDUSTRY" : {
"dataType" : "picklist",
"filterValues" : [ {
"label" : "Agriculture",
"name" : "Agriculture"
}, {
"label" : "Apparel",
"name" : "Apparel"
}, {
"label" : "Banking",
"name" : "Banking"
}, {
"label" : "Biotechnology",
"name" : "Biotechnology"
}, {
14
Examples: Reports REST API Resources
Create a New Report
"label" : "Chemicals",
"name" : "Chemicals"
}, {
"label" : "Communications",
"name" : "Communications"
}, {
"label" : "Construction",
"name" : "Construction"
}, {
"label" : "Consulting",
"name" : "Consulting"
}, {
"label" : "Education",
"name" : "Education"
}, {
"label" : "Electronics",
"name" : "Electronics"
}, {
"label" : "Energy",
"name" : "Energy"
}, {
"label" : "Engineering",
"name" : "Engineering"
}, {
"label" : "Entertainment",
"name" : "Entertainment"
}, {
"label" : "Environmental",
"name" : "Environmental"
}, {
"label" : "Finance",
"name" : "Finance"
}, {
"label" : "Food & Beverage",
"name" : "Food & Beverage"
}, {
"label" : "Government",
"name" : "Government"
}, {
"label" : "Healthcare",
"name" : "Healthcare"
}, {
"label" : "Hospitality",
"name" : "Hospitality"
}, {
"label" : "Insurance",
"name" : "Insurance"
}, {
"label" : "Machinery",
"name" : "Machinery"
}, {
"label" : "Manufacturing",
"name" : "Manufacturing"
}, {
15
Examples: Reports REST API Resources
Create a New Report
"label" : "Media",
"name" : "Media"
}, {
"label" : "Not For Profit",
"name" : "Not For Profit"
}, {
"label" : "Other",
"name" : "Other"
}, {
"label" : "Recreation",
"name" : "Recreation"
}, {
"label" : "Retail",
"name" : "Retail"
}, {
"label" : "Shipping",
"name" : "Shipping"
}, {
"label" : "Technology",
"name" : "Technology"
}, {
"label" : "Telecommunications",
"name" : "Telecommunications"
}, {
"label" : "Transportation",
"name" : "Transportation"
}, {
"label" : "Utilities",
"name" : "Utilities"
} ],
"filterable" : true,
"label" : "Industry"
},
"EMPLOYEES" : {
"dataType" : "int",
"filterValues" : [ ],
"filterable" : true,
"label" : "Employees"
},
"ACCOUNT_ID" : {
"dataType" : "id",
"filterValues" : [ ],
"filterable" : true,
"label" : "Account ID"
},
"ACCOUNT_LAST_ACTIVITY" : {
"dataType" : "date",
"filterValues" : [ ],
"filterable" : true,
"label" : "Account: Last Activity"
},
"ACCOUNT_CREATED_DATE" : {
"dataType" : "datetime",
"filterValues" : [ ],
16
Examples: Reports REST API Resources
Create a New Report
"filterable" : true,
"label" : "Account: Created Date"
},
"ACCOUNT_LAST_UPDATE" : {
"dataType" : "datetime",
"filterValues" : [ ],
"filterable" : true,
"label" : "Account: Last Modified Date"
},
"ACCOUNT_DESCRIPTION" : {
"dataType" : "textarea",
"filterValues" : [ ],
"filterable" : true,
"label" : "Account Description"
}
},
"label" : "Account: General"
}, {
"columns" : {
"ADDRESS1_STREET" : {
"dataType" : "textarea",
"filterValues" : [ ],
"filterable" : true,
"label" : "Billing Street"
},
"ADDRESS1_LINE1" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Billing Address Line 1"
},
"ADDRESS1_LINE2" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Billing Address Line 2"
},
"ADDRESS1_LINE3" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Billing Address Line 3"
},
"ADDRESS1_CITY" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Billing City"
},
"ADDRESS1_STATE" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Billing State/Province"
17
Examples: Reports REST API Resources
Create a New Report
},
"ADDRESS1_ZIP" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Billing Zip/Postal Code"
},
"ADDRESS1_COUNTRY" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Billing Country"
},
"ADDRESS2_STREET" : {
"dataType" : "textarea",
"filterValues" : [ ],
"filterable" : true,
"label" : "Shipping Street"
},
"ADDRESS2_LINE1" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Shipping Address Line 1"
},
"ADDRESS2_LINE2" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Shipping Address Line 2"
},
"ADDRESS2_LINE3" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Shipping Address Line 3"
},
"ADDRESS2_CITY" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Shipping City"
},
"ADDRESS2_STATE" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Shipping State/Province"
},
"ADDRESS2_ZIP" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Shipping Zip/Postal Code"
18
Examples: Reports REST API Resources
Create a New Report
},
"ADDRESS2_COUNTRY" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Shipping Country"
}
},
"label" : "Account: Address"
}, {
"columns" : {
"PHONE1" : {
"dataType" : "phone",
"filterValues" : [ ],
"filterable" : true,
"label" : "Phone"
},
"PHONE2" : {
"dataType" : "phone",
"filterValues" : [ ],
"filterable" : true,
"label" : "Fax"
},
"URL" : {
"dataType" : "url",
"filterValues" : [ ],
"filterable" : true,
"label" : "Website"
}
},
"label" : "Account: Ph/Fax"
}, {
"columns" : {
"CONTACT" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Primary Contact"
},
"CON.TITLE" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Contact: Title"
},
"CON.PHONE" : {
"dataType" : "phone",
"filterValues" : [ ],
"filterable" : true,
"label" : "Contact: Phone"
},
"CON.EMAIL" : {
"dataType" : "email",
"filterValues" : [ ],
19
Examples: Reports REST API Resources
Create a New Report
"filterable" : true,
"label" : "Contact: Email"
}
},
"label" : "Primary Contact"
}, {
"columns" : {
"CON.ADDRESS2_STREET" : {
"dataType" : "textarea",
"filterValues" : [ ],
"filterable" : true,
"label" : "Mailing Street"
},
"CON.ADDRESS2_LINE1" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Mailing Address Line 1"
},
"CON.ADDRESS2_LINE2" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Mailing Address Line 2"
},
"CON.ADDRESS2_LINE3" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Mailing Address Line 3"
},
"CON.ADDRESS2_CITY" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Mailing City"
},
"CON.ADDRESS2_STATE" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Mailing State/Province"
},
"CON.ADDRESS2_ZIP" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Mailing Zip/Postal Code"
},
"CON.ADDRESS2_COUNTRY" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Mailing Country"
20
Examples: Reports REST API Resources
Create a New Report
},
"CON.ADDRESS1_STREET" : {
"dataType" : "textarea",
"filterValues" : [ ],
"filterable" : true,
"label" : "Other Street"
},
"CON.ADDRESS1_LINE1" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Other Address Line 1"
},
"CON.ADDRESS1_LINE2" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Other Address Line 2"
},
"CON.ADDRESS1_LINE3" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Other Address Line 3"
},
"CON.ADDRESS1_CITY" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Other City"
},
"CON.ADDRESS1_STATE" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Other State/Province"
},
"CON.ADDRESS1_ZIP" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Other Zip/Postal Code"
},
"CON.ADDRESS1_COUNTRY" : {
"dataType" : "string",
"filterValues" : [ ],
"filterable" : true,
"label" : "Other Country"
}
},
"label" : "Contact: Address"
} ],
"dataTypeFilterOperatorMap" : {
"date" : [ {
21
Examples: Reports REST API Resources
Create a New Report
"label" : "equals",
"name" : "equals"
}, {
"label" : "not equal to",
"name" : "notEqual"
}, {
"label" : "less than",
"name" : "lessThan"
}, {
"label" : "greater than",
"name" : "greaterThan"
}, {
"label" : "less or equal",
"name" : "lessOrEqual"
}, {
"label" : "greater or equal",
"name" : "greaterOrEqual"
} ],
"string" : [ {
"label" : "equals",
"name" : "equals"
}, {
"label" : "not equal to",
"name" : "notEqual"
}, {
"label" : "less than",
"name" : "lessThan"
}, {
"label" : "greater than",
"name" : "greaterThan"
}, {
"label" : "less or equal",
"name" : "lessOrEqual"
}, {
"label" : "greater or equal",
"name" : "greaterOrEqual"
}, {
"label" : "contains",
"name" : "contains"
}, {
"label" : "does not contain",
"name" : "notContain"
}, {
"label" : "starts with",
"name" : "startsWith"
} ],
"picklist" : [ {
"label" : "equals",
"name" : "equals"
}, {
"label" : "not equal to",
"name" : "notEqual"
}, {
"label" : "less than",
22
Examples: Reports REST API Resources
Create a New Report
"name" : "lessThan"
}, {
"label" : "greater than",
"name" : "greaterThan"
}, {
"label" : "less or equal",
"name" : "lessOrEqual"
}, {
"label" : "greater or equal",
"name" : "greaterOrEqual"
}, {
"label" : "contains",
"name" : "contains"
}, {
"label" : "does not contain",
"name" : "notContain"
}, {
"label" : "starts with",
"name" : "startsWith"
} ],
"textarea" : [ {
"label" : "equals",
"name" : "equals"
}, {
"label" : "not equal to",
"name" : "notEqual"
}, {
"label" : "less than",
"name" : "lessThan"
}, {
"label" : "greater than",
"name" : "greaterThan"
}, {
"label" : "less or equal",
"name" : "lessOrEqual"
}, {
"label" : "greater or equal",
"name" : "greaterOrEqual"
}, {
"label" : "contains",
"name" : "contains"
}, {
"label" : "does not contain",
"name" : "notContain"
}, {
"label" : "starts with",
"name" : "startsWith"
} ],
"percent" : [ {
"label" : "equals",
"name" : "equals"
}, {
"label" : "not equal to",
"name" : "notEqual"
23
Examples: Reports REST API Resources
Create a New Report
}, {
"label" : "less than",
"name" : "lessThan"
}, {
"label" : "greater than",
"name" : "greaterThan"
}, {
"label" : "less or equal",
"name" : "lessOrEqual"
}, {
"label" : "greater or equal",
"name" : "greaterOrEqual"
} ],
"int" : [ {
"label" : "equals",
"name" : "equals"
}, {
"label" : "not equal to",
"name" : "notEqual"
}, {
"label" : "less than",
"name" : "lessThan"
}, {
"label" : "greater than",
"name" : "greaterThan"
}, {
"label" : "less or equal",
"name" : "lessOrEqual"
}, {
"label" : "greater or equal",
"name" : "greaterOrEqual"
} ],
"url" : [ {
"label" : "equals",
"name" : "equals"
}, {
"label" : "not equal to",
"name" : "notEqual"
}, {
"label" : "less than",
"name" : "lessThan"
}, {
"label" : "greater than",
"name" : "greaterThan"
}, {
"label" : "less or equal",
"name" : "lessOrEqual"
}, {
"label" : "greater or equal",
"name" : "greaterOrEqual"
}, {
"label" : "contains",
"name" : "contains"
}, {
24
Examples: Reports REST API Resources
Create a New Report
"label" : "does not contain",
"name" : "notContain"
}, {
"label" : "starts with",
"name" : "startsWith"
} ],
"datetime" : [ {
"label" : "equals",
"name" : "equals"
}, {
"label" : "not equal to",
"name" : "notEqual"
}, {
"label" : "less than",
"name" : "lessThan"
}, {
"label" : "greater than",
"name" : "greaterThan"
}, {
"label" : "less or equal",
"name" : "lessOrEqual"
}, {
"label" : "greater or equal",
"name" : "greaterOrEqual"
} ],
"boolean" : [ {
"label" : "equals",
"name" : "equals"
}, {
"label" : "not equal to",
"name" : "notEqual"
} ],
"phone" : [ {
"label" : "equals",
"name" : "equals"
}, {
"label" : "not equal to",
"name" : "notEqual"
}, {
"label" : "less than",
"name" : "lessThan"
}, {
"label" : "greater than",
"name" : "greaterThan"
}, {
"label" : "less or equal",
"name" : "lessOrEqual"
}, {
"label" : "greater or equal",
"name" : "greaterOrEqual"
}, {
"label" : "contains",
"name" : "contains"
}, {
25
Examples: Reports REST API Resources
Create a New Report
"label" : "does not contain",
"name" : "notContain"
}, {
"label" : "starts with",
"name" : "startsWith"
} ],
"currency" : [ {
"label" : "equals",
"name" : "equals"
}, {
"label" : "not equal to",
"name" : "notEqual"
}, {
"label" : "less than",
"name" : "lessThan"
}, {
"label" : "greater than",
"name" : "greaterThan"
}, {
"label" : "less or equal",
"name" : "lessOrEqual"
}, {
"label" : "greater or equal",
"name" : "greaterOrEqual"
} ],
"id" : [ {
"label" : "equals",
"name" : "equals"
}, {
"label" : "not equal to",
"name" : "notEqual"
}, {
"label" : "starts with",
"name" : "startsWith"
} ],
"email" : [ {
"label" : "equals",
"name" : "equals"
}, {
"label" : "not equal to",
"name" : "notEqual"
}, {
"label" : "less than",
"name" : "lessThan"
}, {
"label" : "greater than",
"name" : "greaterThan"
}, {
"label" : "less or equal",
"name" : "lessOrEqual"
}, {
"label" : "greater or equal",
"name" : "greaterOrEqual"
}, {
26
Examples: Reports REST API Resources
Create a New Report
"label" : "contains",
"name" : "contains"
}, {
"label" : "does not contain",
"name" : "notContain"
}, {
"label" : "starts with",
"name" : "startsWith"
} ]
},
"divisionInfo" : null,
"scopeInfo" : {
"defaultValue" : "organization",
"values" : [ {
"allowsDivision" : false,
"label" : "My opportunities",
"value" : "user"
}, {
"allowsDivision" : false,
"label" : "My team's opportunities",
"value" : "team"
}, {
"allowsDivision" : true,
"label" : "All opportunities",
"value" : "organization"
} ]
},
"standardDateFilterDurationGroups" : [ {
"label" : "",
"standardDateFilterDurations" : [ {
"endDate" : "2016-12-12",
"label" : "Custom",
"startDate" : "2016-12-13",
"value" : "CUSTOM"
} ]
}, {
"label" : "Fiscal Year",
"standardDateFilterDurations" : [ {
"endDate" : "2016-12-31",
"label" : "Current FY",
"startDate" : "2016-01-01",
"value" : "THIS_FISCAL_YEAR"
}, {
"endDate" : "2015-12-31",
"label" : "Previous FY",
"startDate" : "2015-01-01",
"value" : "LAST_FISCAL_YEAR"
}, {
"endDate" : "2015-12-31",
"label" : "Previous 2 FY",
"startDate" : "2014-01-01",
"value" : "LAST_N_FISCAL_YEARS:2"
}, {
"endDate" : "2014-12-31",
27
Examples: Reports REST API Resources
Create a New Report
"label" : "2 FY Ago",
"startDate" : "2014-01-01",
"value" : "LAST_N_FISCAL_YEARS_AGO:2"
}, {
"endDate" : "2017-12-31",
"label" : "Next FY",
"startDate" : "2017-01-01",
"value" : "NEXT_FISCAL_YEAR"
}, {
"endDate" : "2016-12-31",
"label" : "Current and Previous FY",
"startDate" : "2015-01-01",
"value" : "THIS_AND_LAST_FISCAL_YEAR:2"
}, {
"endDate" : "2016-12-31",
"label" : "Current and Previous 2 FY",
"startDate" : "2014-01-01",
"value" : "THIS_AND_LAST_N_FISCAL_YEARS:2"
}, {
"endDate" : "2017-12-31",
"label" : "Current and Next FY",
"startDate" : "2016-01-01",
"value" : "THIS_AND_NEXT_FISCAL_YEAR"
} ]
}, {
"label" : "Fiscal Quarter",
"standardDateFilterDurations" : [ {
"endDate" : "2016-12-31",
"label" : "Current FQ",
"startDate" : "2016-10-01",
"value" : "THIS_FISCAL_QUARTER"
}, {
"endDate" : "2017-03-31",
"label" : "Current and Next FQ",
"startDate" : "2016-10-01",
"value" : "THIS_AND_NEXT_FISCAL_QUARTER"
}, {
"endDate" : "2016-12-31",
"label" : "Current and Previous FQ",
"startDate" : "2016-07-01",
"value" : "LAST_AND_THIS_FISCAL_QUARTER"
}, {
"endDate" : "2017-03-31",
"label" : "Next FQ",
"startDate" : "2017-01-01",
"value" : "NEXT_FISCAL_QUARTER"
}, {
"endDate" : "2016-09-30",
"label" : "Previous FQ",
"startDate" : "2016-07-01",
"value" : "LAST_FISCAL_QUARTER"
}, {
"endDate" : "2017-09-30",
"label" : "Current and Next 3 FQ",
28
Examples: Reports REST API Resources
Create a New Report
"startDate" : "2016-10-01",
"value" : "THIS_AND_NEXT_N_FISCAL_QUARTERS:3"
} ]
}, {
"label" : "Calendar Year",
"standardDateFilterDurations" : [ {
"endDate" : "2016-12-31",
"label" : "Current CY",
"startDate" : "2016-01-01",
"value" : "THIS_YEAR"
}, {
"endDate" : "2015-12-31",
"label" : "Previous CY",
"startDate" : "2015-01-01",
"value" : "LAST_YEAR"
}, {
"endDate" : "2015-12-31",
"label" : "Previous 2 CY",
"startDate" : "2014-01-01",
"value" : "LAST_N_YEARS:2"
}, {
"endDate" : "2014-12-31",
"label" : "2 CY Ago",
"startDate" : "2014-01-01",
"value" : "LAST_N_YEARS_AGO:2"
}, {
"endDate" : "2017-12-31",
"label" : "Next CY",
"startDate" : "2017-01-01",
"value" : "NEXT_YEAR"
}, {
"endDate" : "2016-12-31",
"label" : "Current and Previous CY",
"startDate" : "2015-01-01",
"value" : "THIS_AND_LAST_YEAR:2"
}, {
"endDate" : "2016-12-31",
"label" : "Current and Previous 2 CY",
"startDate" : "2014-01-01",
"value" : "THIS_AND_LAST_N_YEARS:2"
}, {
"endDate" : "2017-12-31",
"label" : "Current and Next CY",
"startDate" : "2016-01-01",
"value" : "THIS_AND_NEXT_YEAR"
} ]
}, {
"label" : "Calendar Quarter",
"standardDateFilterDurations" : [ {
"endDate" : "2016-12-31",
"label" : "Current CQ",
"startDate" : "2016-10-01",
"value" : "THIS_QUARTER"
}, {
29
Examples: Reports REST API Resources
Create a New Report
"endDate" : "2017-03-31",
"label" : "Current and Next CQ",
"startDate" : "2016-10-01",
"value" : "THIS_AND_NEXT_QUARTER"
}, {
"endDate" : "2016-12-31",
"label" : "Current and Previous CQ",
"startDate" : "2016-07-01",
"value" : "LAST_AND_THIS_QUARTER"
}, {
"endDate" : "2017-03-31",
"label" : "Next CQ",
"startDate" : "2017-01-01",
"value" : "NEXT_QUARTER"
}, {
"endDate" : "2016-09-30",
"label" : "Previous CQ",
"startDate" : "2016-07-01",
"value" : "LAST_QUARTER"
}, {
"endDate" : "2017-09-30",
"label" : "Current and Next 3 CQ",
"startDate" : "2016-10-01",
"value" : "THIS_AND_NEXT_N_QUARTERS:3"
} ]
}, {
"label" : "Calendar Month",
"standardDateFilterDurations" : [ {
"endDate" : "2016-11-30",
"label" : "Last Month",
"startDate" : "2016-11-01",
"value" : "LAST_MONTH"
}, {
"endDate" : "2016-12-31",
"label" : "This Month",
"startDate" : "2016-12-01",
"value" : "THIS_MONTH"
}, {
"endDate" : "2017-01-31",
"label" : "Next Month",
"startDate" : "2017-01-01",
"value" : "NEXT_MONTH"
}, {
"endDate" : "2016-12-31",
"label" : "Current and Previous Month",
"startDate" : "2016-11-01",
"value" : "LAST_AND_THIS_MONTH"
}, {
"endDate" : "2017-01-31",
"label" : "Current and Next Month",
"startDate" : "2016-12-01",
"value" : "THIS_AND_NEXT_MONTH"
} ]
}, {
30
Examples: Reports REST API Resources
Create a New Report
"label" : "Calendar Week",
"standardDateFilterDurations" : [ {
"endDate" : "2016-12-10",
"label" : "Last Week",
"startDate" : "2016-12-04",
"value" : "LAST_WEEK"
}, {
"endDate" : "2016-12-17",
"label" : "This Week",
"startDate" : "2016-12-11",
"value" : "THIS_WEEK"
}, {
"endDate" : "2016-12-24",
"label" : "Next Week",
"startDate" : "2016-12-18",
"value" : "NEXT_WEEK"
} ]
}, {
"label" : "Day",
"standardDateFilterDurations" : [ {
"endDate" : "2016-12-12",
"label" : "Yesterday",
"startDate" : "2016-12-12",
"value" : "YESTERDAY"
}, {
"endDate" : "2016-12-13",
"label" : "Today",
"startDate" : "2016-12-13",
"value" : "TODAY"
}, {
"endDate" : "2016-12-14",
"label" : "Tomorrow",
"startDate" : "2016-12-14",
"value" : "TOMORROW"
}, {
"endDate" : "2016-12-13",
"label" : "Last 7 Days",
"startDate" : "2016-12-07",
"value" : "LAST_N_DAYS:7"
}, {
"endDate" : "2016-12-13",
"label" : "Last 30 Days",
"startDate" : "2016-11-14",
"value" : "LAST_N_DAYS:30"
}, {
"endDate" : "2016-12-13",
"label" : "Last 60 Days",
"startDate" : "2016-10-15",
"value" : "LAST_N_DAYS:60"
}, {
"endDate" : "2016-12-13",
"label" : "Last 90 Days",
"startDate" : "2016-09-15",
"value" : "LAST_N_DAYS:90"
31
Examples: Reports REST API Resources
Create a New Report
}, {
"endDate" : "2016-12-13",
"label" : "Last 120 Days",
"startDate" : "2016-08-16",
"value" : "LAST_N_DAYS:120"
}, {
"endDate" : "2016-12-19",
"label" : "Next 7 Days",
"startDate" : "2016-12-13",
"value" : "NEXT_N_DAYS:7"
}, {
"endDate" : "2017-01-11",
"label" : "Next 30 Days",
"startDate" : "2016-12-13",
"value" : "NEXT_N_DAYS:30"
}, {
"endDate" : "2017-02-10",
"label" : "Next 60 Days",
"startDate" : "2016-12-13",
"value" : "NEXT_N_DAYS:60"
}, {
"endDate" : "2017-03-12",
"label" : "Next 90 Days",
"startDate" : "2016-12-13",
"value" : "NEXT_N_DAYS:90"
}, {
"endDate" : "2017-04-11",
"label" : "Next 120 Days",
"startDate" : "2016-12-13",
"value" : "NEXT_N_DAYS:120"
} ]
} ],
"standardFilterInfos" : {
"probability" : {
"type" : "PICKLIST",
"filterValues" : [ {
"label" : "All",
"name" : ">0"
}, {
"label" : "> 90%",
"name" : "gt90"
}, {
"label" : "> 80%",
"name" : "gt80"
}, {
"label" : "> 70%",
"name" : "gt70"
}, {
"label" : "> 60%",
"name" : "gt60"
}, {
"label" : "> 50%",
"name" : "gt50"
}, {
32
Examples: Reports REST API Resources
Create a New Report
"label" : "> 40%",
"name" : "gt40"
}, {
"label" : "> 30%",
"name" : "gt30"
}, {
"label" : "> 20%",
"name" : "gt20"
}, {
"label" : "> 10%",
"name" : "gt10"
}, {
"label" : "< 90%",
"name" : "lt90"
}, {
"label" : "< 80%",
"name" : "lt80"
}, {
"label" : "< 70%",
"name" : "lt70"
}, {
"label" : "< 60%",
"name" : "lt60"
}, {
"label" : "< 50%",
"name" : "lt50"
}, {
"label" : "< 40%",
"name" : "lt40"
}, {
"label" : "< 30%",
"name" : "lt30"
}, {
"label" : "< 20%",
"name" : "lt20"
}, {
"label" : "< 10%",
"name" : "lt10"
} ],
"label" : "Probability"
},
"open" : {
"type" : "PICKLIST",
"filterValues" : [ {
"label" : "Any",
"name" : "all"
}, {
"label" : "Open",
"name" : "open"
}, {
"label" : "Closed",
"name" : "closed"
}, {
"label" : "Closed Won",
33
Examples: Reports REST API Resources
Run Reports Synchronously or Asynchronously
"name" : "closedwon"
} ],
"label" : "Opportunity Status"
}
}
}
}
Run Reports Synchronously or Asynchronously
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:
• Send a GET or POST request to the Execute Sync resource to get data.
• Use a POST request to get specific results on the fly by passing dynamic filters, groupings, and aggregates in the report metadata.
To fetch report data asynchronously:
1. 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.
2. Send a GET request to the Instance Results resource to fetch data using the instance ID.
Example of a synchronous report run
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.
{
"attributes" : {
"describeUrl" :
"/services/data/v35.0/analytics/reports/00OR0000000K2UeMAK/describe",
"instancesUrl" :
"/services/data/v35.0/analytics/reports/00OR0000000K2UeMAK/instances",
"reportId" :
"00OR0000000K2UeMAK",
"reportName" : "Deals Closing This Quarter",
"type" : "Report"
},
"allData" : true,
"factMap" : {
"2!0_0" : {
34
Examples: Reports REST API Resources
Run Reports Synchronously or Asynchronously
"aggregates" : [
{ "label" : "$16,000.01", "value" : 16000.010000000000218278728425502777099609375
},
{ "label" : "$16,000.01", "value" : 16000.010000000000218278728425502777099609375
},
{ "label" : "1", "value" : 1 } ],
"rows" : [ {
"dataCells" : [
{ "label" : "Acme - 200 Widgets", "value" : "006R00000023IDYIA2" },
{ "label" : "$16,000.01",
"value" : { "amount" : 16000.01, "currency" : null } },
{ "label" : "Word of mouth", "value" : "Word of mouth" },
{ "label" : "Need estimate", "value" : "Need estimate" },
{ "label" : "60%", "value" : 60},
{ "label" : "Q3-2015", "value" : "Q3-2015" },
{ "label" : "12", "value" : 12 },
{ "label" : "7/31/2015", "value" : "2015-07-31" },
{ "label" : "Fred Wiliamson", "value" : "005R0000000Hv5rIAC" },
{ "label" : "-", "value" : null } ]
} ]
},
"T!0" : {
"aggregates" : [
{ "label" : "$32,021.01", "value" : 32021.00999999999839928932487964630126953125
},
{ "label" : "$16,010.51", "value" : 16010.504999999999199644662439823150634765625
},
{ "label" : "2", "value" : 2 } ],
"rows" : [ ]
},
...
"T!T" : {
"aggregates" : [
{ "label" : "$153,042.01", "value" : 153042.01000000000931322574615478515625 },
{ "label" : "$25,507.00", "value" : 25507.00166666666700621135532855987548828125
},
{ "label" : "6", "value" : 6 } ],
"rows" : [ ]
},
...
"groupingsAcross" : {
"groupings" : [
{
"groupings" : [
{ "groupings" : [ ], "key" : "0_0", "label" : "Existing Business", "value" :
"Existing Business" } ],
"key" : "0",
"label" : "July 2015",
"value" : "2015-07-01"
},
{
"groupings" : [
{ "groupings" : [ ], "key" : "1_0", "label" : "Existing Business", "value" :
"Existing Business" },
35
Examples: Reports REST API Resources
Run Reports Synchronously or Asynchronously
{ "groupings" : [ ], "key" : "1_1", "label" : "New Business", "value" : "New
Business" } ],
"key" : "1",
"label" : "August 2015",
"value" : "2015-08-01"
},
{
"groupings" : [
{ "groupings" : [ ], "key" : "2_0", "label" : "Existing Business", "value" :
"Existing Business" } ],
"key" : "2",
"label" : "September 2015",
"value" : "2015-09-01"
}
]
},
"groupingsDown" : {
"groupings" : [
{ "groupings" : [ ], "key" : "0", "label" : "Acme", "value" : "001R0000002GuzsIAC"
},
{ "groupings" : [ ], "key" : "1", "label" : "Facebook", "value" : "001R0000001nUAmIAM"
},
{ "groupings" : [ ], "key" : "2", "label" : "Home Depot", "value" :
"001R0000002Gv5zIAC" },
{ "groupings" : [ ], "key" : "3", "label" : "Mircosoft", "value" : "001R0000002Gv5QIAS"
} ]
},
"hasDetailRows" : true,
"reportExtendedMetadata" : {
"aggregateColumnInfo" : {
"s!AMOUNT" : {
"acrossGroupingContext" : null,
"dataType" : "currency",
"downGroupingContext" : null,
"label" : "Sum of Amount" },
"a!AMOUNT" : {
"acrossGroupingContext" : null,
"dataType" : "currency",
"downGroupingContext" : null,
"label" : "Average Amount" },
"RowCount" : {
"acrossGroupingContext" : null,
"dataType" : "int",
"downGroupingContext" : null,
"label" : "Record Count" }
},
"detailColumnInfo" : {
"OPPORTUNITY_NAME" : { "dataType" : "string", "label" : "Opportunity Name" },
"AMOUNT" : { "dataType" : "currency", "label" : "Amount" },
"LEAD_SOURCE" : { "dataType" : "picklist", "label" : "Lead Source" },
"NEXT_STEP" : { "dataType" : "string", "label" : "Next Step" },
"PROBABILITY" : { "dataType" : "percent", "label" : "Probability (%)" },
"FISCAL_QUARTER" : { "dataType" : "string", "label" : "Fiscal Period" },
36
Examples: Reports REST API Resources
Run Reports Synchronously or Asynchronously
"AGE" : { "dataType" : "int", "label" : "Age" },
"CREATED_DATE" : { "dataType" : "datetime", "label" : "Created Date" },
"FULL_NAME" : { "dataType" : "string", "label" : "Opportunity Owner" },
"ROLLUP_DESCRIPTION" : { "dataType" : "string", "label" : "Owner Role" }
},
"groupingColumnInfo" : {
"ACCOUNT_NAME" : { "dataType" : "string", "groupingLevel" : 0, "label" : "Account
Name" },
"CLOSE_DATE" : { "dataType" : "date", "groupingLevel" : 0, "label" : "Close Date"
},
"TYPE" : { "dataType" : "picklist", "groupingLevel" : 1, "label" : "Type" }
}
},
"reportMetadata" : {
"aggregates" : [ "s!AMOUNT", "a!AMOUNT", "RowCount" ],
"chart" : {
"chartType" : "Donut",
"groupings" : [ "CLOSE_DATE" ],
"hasLegend" : true,
"showChartValues" : false,
"summaries" : [ "s!AMOUNT" ],
"summaryAxisLocations" : [ "Y" ],
"title" : "Pipeline by Stage and Type"
},
"currency" : null,
"description" : null,
"detailColumns" : [ "OPPORTUNITY_NAME", "AMOUNT", "LEAD_SOURCE","NEXT_STEP",
"PROBABILITY", "FISCAL_QUARTER", "AGE", "CREATED_DATE", "FULL_NAME",
"ROLLUP_DESCRIPTION" ],
"developerName" : "Deals_Closing_This_Quarter",
"division" : null,
"folderId" : "00lR0000000M8IiIAK",
"groupingsAcross" : [
{ "dateGranularity" : "Month", "name" : "CLOSE_DATE", "sortAggregate" : null,
"sortOrder" : "Asc"},
{ "dateGranularity" : "None", "name" : "TYPE", "sortAggregate" : null, "sortOrder"
: "Asc" } ],
"groupingsDown" : [
{ "dateGranularity" : "None", "name" : "ACCOUNT_NAME", "sortAggregate" : null,
"sortOrder" : "Asc" } ],
"hasDetailRows" : true,
"hasRecordCount" : true,
"historicalSnapshotDates" : [ ],
"id" : "00OR0000000K2UeMAK",
"name" : "Deals Closing This Quarter",
"reportBooleanFilter" : null,
"reportFilters" : [
{ "column" : "BucketField_36625466", "isRunPageEditable" : true, "operator" : "equals",
"value" : "Early,Late" },
{ "column" : "TYPE", "isRunPageEditable" : true, "operator" : "equals", "value" :
"Existing Business,New Business" } ],
"reportFormat" : "MATRIX",
"reportType" : { "label" : "Opportunities", "type" : "Opportunity" },
"scope" : "organization",
37
Examples: Reports REST API Resources
Run Reports Synchronously or Asynchronously
"showGrandTotal" : true,
"showSubtotals" : true,
"sortBy" : [ ],
"standardDateFilter" : {
"column" : "CLOSE_DATE",
"durationValue" : "THIS_FISCAL_QUARTER",
"endDate" : "2015-09-30",
"startDate" : "2015-07-01" },
"standardFilters" : [
{ "name" : "open", "value" : "all" },
{ "name" : "probability", "value" : ">0" } ]
}
}
Example of an asynchronous report run
1. This is a POST request, /services/data/v35.0/analytics/reports/00OR0000000K2UeMAK/instances,
to the Execute Async resource for an asynchronous run requesting summary results.
{
"reportMetadata": {
"aggregates": [
"s!AMOUNT",
"a!AMOUNT",
"RowCount"],
"chart": {
"chartType": "Donut",
"groupings": [ "CLOSE_DATE" ],
"hasLegend": true,
"showChartValues": false,
"summaries": [ "s!AMOUNT" ],
"summaryAxisLocations": [ "Y" ],
"title": "Pipeline by Stage and Type" },
"currency": null,
"detailColumns": [
"OPPORTUNITY_NAME",
"AMOUNT",
"LEAD_SOURCE",
"NEXT_STEP",
"PROBABILITY",
"FISCAL_QUARTER",
"AGE",
"CREATED_DATE",
"FULL_NAME",
"ROLLUP_DESCRIPTION" ],
"developerName": "Deals_Closing_This_Quarter",
"division": null,
"folderId": "00lR0000000M8IiIAK",
"groupingsAcross": [
{ "dateGranularity": "Month", "name": "CLOSE_DATE", "sortAggregate": null,
"sortOrder": "Asc" },
{ "dateGranularity": "None", "name": "TYPE", "sortAggregate": null, "sortOrder":
"Asc" } ],
38
Examples: Reports REST API Resources
Run Reports Synchronously or Asynchronously
"groupingsDown": [
{ "dateGranularity": "None", "name": "ACCOUNT_NAME", "sortAggregate": null,
"sortOrder": "Asc" } ],
"hasDetailRows": true,
"hasRecordCount": true,
"historicalSnapshotDates": [],
"id": "00OR0000000K2UeMAK",
"name": "Deals Closing This Quarter",
"reportBooleanFilter": null,
"reportFilters": [
{
"column": "BucketField_36625466",
"isRunPageEditable": true,
"operator": "equals",
"value": "Early,Late" },
{
"column": "TYPE",
"isRunPageEditable": true,
"operator": "equals",
"value": "Existing Business,New Business" } ],
"reportFormat": "MATRIX",
"reportType": { "label": "Opportunities", "type": "Opportunity" },
"scope": "organization",
"sortBy": [],
"standardDateFilter": {
"column": "CLOSE_DATE",
"durationValue": "THIS_FISCAL_QUARTER",
"endDate": "2015-09-30",
"startDate": "2015-07-01" },
"standardFilters": [
{ "name": "open", "value": "all" },
{ "name": "probability", "value": ">0" } ]
}
}
The response to the POST request returns the instance handle that stores the summary results of the run.
{
"completionDate" : null,
"hasDetailRows" : true,
"id" : "0LGR00000000He3OAE",
"ownerId" : "005R0000000Hv5rIAC",
"queryable" : false,
"requestDate" : "2015-08-12T16:05:43Z",
"status" : "New",
"url" :
"/services/data/v35.0/analytics/reports/00OR0000000K2UeMAK/instances/0LGR00000000He3OAE"
}
2. 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.
{
"attributes" : {
39
Examples: Reports REST API Resources
Run Reports Synchronously or Asynchronously
"completionDate" : "2015-08-12T16:05:44Z",
"id" : "0LGR00000000He3OAE",
"ownerId" : "005R0000000Hv5rIAC",
"queryable" : false,
"reportId" : "00OR0000000K2UeMAK",
"reportName" : "Deals Closing This Quarter",
"requestDate" : "2015-08-12T16:05:43Z",
"status" : "Success",
"type" : "ReportInstance" },
"allData" : true,
"factMap" : {
"2!0_0" : {
"aggregates" : [
{ "label" : "$16,000.01", "value" : 16000.010000000000218278728425502777099609375
},
{ "label" : "$16,000.01", "value" : 16000.010000000000218278728425502777099609375
},
{ "label" : "1", "value" : 1 } ],
"rows" : [ {
"dataCells" : [
{ "label" : "Acme - 200 Widgets", "value" : "006R00000023IDYIA2" },
{ "label" : "$16,000.01",
"value" : { "amount" : 16000.01,
"currency" : null } },
{ "label" : "Word of mouth", "value" : "Word of mouth" },
{ "label" : "Need estimate", "value" : "Need estimate" },
{ "label" : "60%", "value" : 60 },
{ "label" : "Q3-2015", "value" : "Q3-2015" },
{ "label" : "12", "value" : 12 },
{ "label" : "7/31/2015", "value" : "2015-07-31" },
{ "label" : "Fred Wiliamson", "value" : "005R0000000Hv5rIAC" },
{ "label" : "-", "value" : null } ]
} ]
},
...
"groupingsAcross" : {
"groupings" : [
...
]
},
"groupingsDown" : {
"groupings" : [
...
]
},
"hasDetailRows" : true,
"reportExtendedMetadata" : {
"aggregateColumnInfo" : {
"s!AMOUNT" : {
"acrossGroupingContext" : null,
"dataType" : "currency",
"downGroupingContext" : null,
"label" : "Sum of Amount" },
"a!AMOUNT" : {
40
Examples: Reports REST API Resources
Run Reports Synchronously or Asynchronously
"acrossGroupingContext" : null,
"dataType" : "currency",
"downGroupingContext" : null,
"label" : "Average Amount" },
"RowCount" : {
"acrossGroupingContext" : null,
"dataType" : "int",
"downGroupingContext" : null,
"label" : "Record Count" }
},
"detailColumnInfo" :
{ "OPPORTUNITY_NAME" : { "dataType" : "string", "label" : "Opportunity Name" },
"AMOUNT" : { "dataType" : "currency", "label" : "Amount"},
"LEAD_SOURCE" : { "dataType" : "picklist", "label" : "Lead Source" },
"NEXT_STEP" : { "dataType" : "string", "label" : "Next Step" },
"PROBABILITY" : { "dataType" : "percent", "label" : "Probability (%)" },
"FISCAL_QUARTER" : { "dataType" : "string", "label" : "Fiscal Period" },
"AGE" : { "dataType" : "int", "label" : "Age" },
"CREATED_DATE" : { "dataType" : "datetime", "label" : "Created Date" },
"FULL_NAME" : { "dataType" : "string", "label" : "Opportunity Owner" },
"ROLLUP_DESCRIPTION" : { "dataType" : "string", "label" : "Owner Role" } },
"groupingColumnInfo" : {
"ACCOUNT_NAME" : { "dataType" : "string", "groupingLevel" : 0, "label" : "Account
Name" },
"CLOSE_DATE" : { "dataType" : "date", "groupingLevel" : 0, "label" : "Close Date"
},
"TYPE" : { "dataType" : "picklist", "groupingLevel" : 1, "label" : "Type" }}
},
"reportMetadata" : {
"aggregates" : [ "s!AMOUNT", "a!AMOUNT", "RowCount" ],
"chart" : {
"chartType" : "Donut",
"groupings" : [ "CLOSE_DATE" ],
"hasLegend" : true,
"showChartValues" : false,
"summaries" : [ "s!AMOUNT" ],
"summaryAxisLocations" : [ "Y" ],
"title" : "Pipeline by Stage and Type" },
"currency" : null,
"description" : null,
"detailColumns" : [ "OPPORTUNITY_NAME", "AMOUNT", "LEAD_SOURCE", "NEXT_STEP",
"PROBABILITY",
"FISCAL_QUARTER", "AGE", "CREATED_DATE", "FULL_NAME", "ROLLUP_DESCRIPTION" ],
"developerName" : "Deals_Closing_This_Quarter",
"division" : null,
"folderId" : "00lR0000000M8IiIAK",
"groupingsAcross" : [
{ "dateGranularity" : "Month", "name" : "CLOSE_DATE", "sortAggregate" : null,
"sortOrder" : "Asc" },
{ "dateGranularity" : "None", "name" : "TYPE", "sortAggregate" : null, "sortOrder"
41
Examples: Reports REST API Resources
Get Report Metadata
: "Asc" } ],
"groupingsDown" : [
{ "dateGranularity" : "None", "name" : "ACCOUNT_NAME", "sortAggregate" : null,
"sortOrder" : "Asc" } ],
"hasDetailRows" : true,
"hasRecordCount" : true,
"historicalSnapshotDates" : [ ],
"id" : "00OR0000000K2UeMAK",
"name" : "Deals Closing This Quarter",
"reportBooleanFilter" : null,
"reportFilters" : [
{ "column" : "BucketField_36625466", "isRunPageEditable" : false, "operator" :
"equals", "value" : "Early,Late" },
{ "column" : "TYPE", "isRunPageEditable" : false, "operator" : "equals", "value"
: "Existing Business,New Business" } ],
"reportFormat" : "MATRIX",
"reportType" : { "label" : "Opportunities", "type" : "Opportunity" },
"scope" : "organization",
"showGrandTotal" : true,
"showSubtotals" : true,
"sortBy" : [ ],
"standardDateFilter" : {
"column" : "CLOSE_DATE",
"durationValue" : "THIS_FISCAL_QUARTER",
"endDate" : "2015-09-30",
"startDate" : "2015-07-01" },
"standardFilters" : [
{ "name" : "open", "value" : "all" },
{ "name" : "probability", "value" : ">0" } ]
}
}
SEE ALSO:
Execute Sync
Instances List
Instance Results
Get Report Metadata
Report metadata gives information about a report and its report type. It includes information on fields used in the report for filters,
groupings, detailed data, and summaries. You can use the metadata to do several things.
• Find out what fields in the report type you can filter on and by what values.
• Build custom chart visualizations using the metadata information on fields, groupings, detailed data, and summaries.
• Change filters in the report metadata during a report run.
To get report metadata, send a GET request to the Describe resource.
42
Examples: Reports REST API Resources
Get Report Metadata
Example
This GET request, /services/data/v29.0/analytics/reports/00OD0000001ZbP7MAK/describe, to the Describe
resource returns metadata for a matrix report. This includes a bucket field, groupings, summaries, and a custom summary formula.
{
"reportTypeMetadata": {
"categories": [
{
"label": "Opportunity Information",
"columns": {
"CREATED": {
"filterValues": [],
"label": "Created By",
"dataType": "string",
"filterable": true
},
...
"TYPE": {
"filterValues": [
{
"name": "Add-On Business",
"label": "Add-On Business"
},
{
"name": "New Business",
"label": "New Business"
},
{
"name": "Services",
"label": "Services"
}
],
"label": "Type",
"dataType": "picklist",
"filterable": true
},
}
...
},
"reportExtendedMetadata": {
"detailColumnInfo": {
"OPPORTUNITY_NAME": {
"label": "Opportunity Name",
"dataType": "string"
},
"PROBABILITY": {
"label": "Probability (%)",
"dataType": "percent"
},
"EXP_AMOUNT": {
"label": "Expected Revenue",
"dataType": "currency"
},
"NEXT_STEP": {
43
Examples: Reports REST API Resources
Get Report Metadata
"label": "Next Step",
"dataType": "string"
},
"BucketField_34840671": {
"label": "Industry",
"dataType": "string"
}
},
"aggregateColumnInfo": {
"RowCount": {
"label": "Record Count",
"dataType": "int",
"downGroupingContext": null,
"acrossGroupingContext": null
},
"FORMULA1": {
"label": "formula1",
"dataType": "double",
"downGroupingContext": "ALL_SUMMARY_LEVELS",
"acrossGroupingContext": "ALL_SUMMARY_LEVELS"
},
"s!EXP_AMOUNT": {
"label": "Sum of Expected Revenue",
"dataType": "currency",
"downGroupingContext": null,
"acrossGroupingContext": null
}
},
"groupingColumnInfo": {
"CLOSE_DATE": {
"label": "Close Date",
"dataType": "date",
"groupingLevel": 1
},
"STAGE_NAME": {
"label": "Stage",
"dataType": "picklist",
"groupingLevel": 0
},
"ACCOUNT_NAME": {
"label": "Account Name",
"dataType": "string",
"groupingLevel": 0
},
"ACCOUNT_LAST_ACTIVITY": {
"label": "Account: Last Activity",
"dataType": "date",
"groupingLevel": 1
}
}
},
"reportMetadata": {
"name": "Stuck Opportunities",
"id": "00OD0000001ZbP7MAK",
44
Examples: Reports REST API Resources
Get Report Metadata
"currency": null,
"developerName": "StuckOpportunities",
"groupingsDown": [
{
"name": "ACCOUNT_NAME",
"sortOrder": "Asc",
"dateGranularity": "None"
},
{
"name": "CLOSE_DATE",
"sortOrder": "Desc",
"dateGranularity": "FiscalQuarter"
}
],
"groupingsAcross": [
{
"name": "STAGE_NAME",
"sortOrder": "Desc",
"dateGranularity": "None"
},
{
"name": "ACCOUNT_LAST_ACTIVITY",
"sortOrder": "Asc",
"dateGranularity": "Week"
}
],
"reportType": {
"type": "Opportunity",
"label": "Opportunities"
},
"aggregates": [
"s!EXP_AMOUNT",
"FORMULA1",
"RowCount"
],
"reportFormat": "MATRIX",
"reportBooleanFilter": null,
"reportFilters": [
{
"value": "Closed Won,Closed Lost",
"column": "STAGE_NAME",
"operator": "notEqual"
},
{
"value": "50",
"column": "PROBABILITY",
"operator": "greaterThan"
}
],
"detailColumns": [
"OPPORTUNITY_NAME",
"PROBABILITY",
"EXP_AMOUNT",
"NEXT_STEP",
45
Examples: Reports REST API Resources
Get a List of Report Types
"BucketField_34840671"
]
}
}
SEE ALSO:
Describe
Get a List of Report Types
Return a list of analytics notifications using a GET request.
Use a GET request on the Report Type List resource to return a list of report types.
Example Usage
/services/data/v39.0/analytics/reportTypes
Example Response Body
[ {
"label" : "Accounts & Contacts",
"reportTypes" : [ {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/AccountList",
"label" : "Accounts",
"type" : "AccountList"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/ContactList",
"label" : "Contacts & Accounts",
"type" : "ContactList"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/AccountPartner",
"label" : "Accounts with Partners",
"type" : "AccountPartner"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/AccountTeam",
"label" : "Account with Account Teams",
"type" : "AccountTeam"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/AccountContactRole",
"label" : "Accounts with Contact Roles",
"type" : "AccountContactRole"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/AccountAsset",
"label" : "Accounts with Assets",
"type" : "AccountAsset"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/ContactAsset",
"label" : "Contacts with Assets",
"type" : "ContactAsset"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/AccountAuditHistory",
"label" : "Account History",
"type" : "AccountAuditHistory"
46
Examples: Reports REST API Resources
Get a List of Report Types
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/ContactAuditHistory",
"label" : "Contact History",
"type" : "ContactAuditHistory"
} ]
}, {
"label" : "Opportunities",
"reportTypes" : [ {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/Opportunity",
"label" : "Opportunities",
"type" : "Opportunity"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/OpportunityProduct",
"label" : "Opportunities with Products",
"type" : "OpportunityProduct"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/OpportunityContact",
"label" : "Opportunities with Contact Roles",
"type" : "OpportunityContact"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/OpportunityPartner",
"label" : "Opportunities with Partners",
"type" : "OpportunityPartner"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/OpportunityCompetitor",
"label" : "Opportunities with Competitors",
"type" : "OpportunityCompetitor"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/OpportunityHistory",
"label" : "Opportunity History",
"type" : "OpportunityHistory"
}, {
"describeUrl" :
"/services/data/v39.0/analytics/reportTypes/OpportunityFieldAuditHistory",
"label" : "Opportunity Field History",
"type" : "OpportunityFieldAuditHistory"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/OpportunityTrend",
"label" : "Opportunity Trends",
"type" : "OpportunityTrend"
}, {
"describeUrl" :
"/services/data/v39.0/analytics/reportTypes/OpportunityContactProduct",
"label" : "Opportunities with Contact Roles and Products",
"type" : "OpportunityContactProduct"
} ]
}, {
"label" : "Customer Support Reports",
"reportTypes" : [ {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/CaseList",
"label" : "Cases",
"type" : "CaseList"
}, {
47
Examples: Reports REST API Resources
Get a List of Report Types
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/CaseHistory",
"label" : "Case Lifecycle",
"type" : "CaseHistory"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/CaseContactRole",
"label" : "Cases with Contact Roles",
"type" : "CaseContactRole"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/CaseAsset",
"label" : "Cases with Assets",
"type" : "CaseAsset"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/CaseSolution",
"label" : "Cases with Solutions",
"type" : "CaseSolution"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/CaseAuditHistory",
"label" : "Case History",
"type" : "CaseAuditHistory"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/SolutionList",
"label" : "Solutions",
"type" : "SolutionList"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/SolutionCategory",
"label" : "Solution Categories",
"type" : "SolutionCategory"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/SolutionAuditHistory",
"label" : "Solution History",
"type" : "SolutionAuditHistory"
} ]
}, {
"label" : "Leads",
"reportTypes" : [ {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/LeadList",
"label" : "Leads",
"type" : "LeadList"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/OpportunityLead",
"label" : "Leads with converted lead information",
"type" : "OpportunityLead"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/LeadAuditHistory",
"label" : "Lead History",
"type" : "LeadAuditHistory"
} ]
}, {
"label" : "Activities",
"reportTypes" : [ {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/Activity",
"label" : "Tasks and Events",
"type" : "Activity"
}, {
48
Examples: Reports REST API Resources
Get a List of Report Types
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/EventAttendee",
"label" : "Events with Invitees",
"type" : "EventAttendee"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/EmailStatus",
"label" : "HTML Email Status",
"type" : "EmailStatus"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/AccountActivity",
"label" : "Activities with Accounts",
"type" : "AccountActivity"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/ContactActivity",
"label" : "Activities with Contacts",
"type" : "ContactActivity"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/OpportunityActivity",
"label" : "Activities with Opportunities",
"type" : "OpportunityActivity"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/LeadActivity",
"label" : "Activities with Leads",
"type" : "LeadActivity"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/CaseActivity",
"label" : "Activities with Cases",
"type" : "CaseActivity"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/SolutionActivity",
"label" : "Activities with Solutions",
"type" : "SolutionActivity"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/ContractActivity",
"label" : "Activities with Contracts",
"type" : "ContractActivity"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/ProductActivity",
"label" : "Activities with Products",
"type" : "ProductActivity"
} ]
}, {
"label" : "Contracts and Orders",
"reportTypes" : [ {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/ContractList",
"label" : "Contracts",
"type" : "ContractList"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/ContractAuditHistory",
"label" : "Contract History",
"type" : "ContractAuditHistory"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/ContractOrder",
"label" : "Contracts with Orders",
"type" : "ContractOrder"
49
Examples: Reports REST API Resources
Get a List of Report Types
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/ContractOrderItem",
"label" : "Contracts with Orders and Products",
"type" : "ContractOrderItem"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/ContractContactRole",
"label" : "Contracts with Contact Roles",
"type" : "ContractContactRole"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/OrderList",
"label" : "Orders",
"type" : "OrderList"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/OrderItemList",
"label" : "Orders with Products",
"type" : "OrderItemList"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/OrderAuditHistory",
"label" : "Order History",
"type" : "OrderAuditHistory"
} ]
}, {
"label" : "Price Books, Products and Assets",
"reportTypes" : [ {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/ProductList",
"label" : "Products",
"type" : "ProductList"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/ProductOpportunity",
"label" : "Products with Opportunities",
"type" : "ProductOpportunity"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/PricebookProduct",
"label" : "Price Books with Products",
"type" : "PricebookProduct"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/ProductAsset",
"label" : "Products with Assets",
"type" : "ProductAsset"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/AssetWithProduct",
"label" : "Assets",
"type" : "AssetWithProduct"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/AssetCase",
"label" : "Assets with Cases",
"type" : "AssetCase"
} ]
}, {
"label" : "Administrative Reports",
"reportTypes" : [ {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/User",
"label" : "Users",
"type" : "User"
50
Examples: Reports REST API Resources
List Asynchronous Runs of a Report
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/ReportList",
"label" : "Reports",
"type" : "ReportList"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/DocumentList",
"label" : "Documents",
"type" : "DocumentList"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/LoginIpEmail",
"label" : "New Login Locations",
"type" : "LoginIpEmail"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/TwoFactorMethodsInfo",
"label" : "Identity Verification Methods",
"type" : "TwoFactorMethodsInfo"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/CollabGroup",
"label" : "Collaboration Group Report",
"type" : "CollabGroup"
}, {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/CollabGroupFeedPosts",
"label" : "Collaboration Group Feed Posts Report",
"type" : "CollabGroupFeedPosts"
} ]
}, {
"label" : "File and Content Reports",
"reportTypes" : [ {
"describeUrl" : "/services/data/v39.0/analytics/reportTypes/File",
"label" : "File and Content Report",
"type" : "File"
} ]
} ]
List Asynchronous Runs of a Report
You can get as many as 2000 instances of a report for which you requested asynchronous runs by sending a GET request to the Instances
List resource. The instance list is sorted by the date when the run was requested. Report results are stored for a rolling 24-hour period.
During this time, based on your user access level, you can access results for each instance of the report that was run.
Example
A GET request, /services/data/v29.0/analytics/reports/00OD0000001ZbP7MAK/instances, to the Instances
List resource returns two instances of the report that was run asynchronously. Each URL handle stores report results for that instance.
[
{
"id": "0LGD000000000IyOAI",
"requestDate": "2013-08-12T19:06:47Z",
"status": "Success",
"url":
"/services/data/v29.0/analytics/reports/00OD0000001ZbP7MAK/instances/0LGD000000000IyOAI",
51
Examples: Reports REST API Resources
Filter Reports on Demand
"ownerId": "005D0000001KvxRIAS",
"queryable" : false,
"hasDetailRows": false,
"completionDate": "2013-08-12T19:06:48Z"
},
{
"id": "0LGD000000000IjOAI",
"requestDate": "2013-08-12T18:39:06Z",
"status": "Success",
"url":
"/services/data/v29.0/analytics/reports/00OD0000001ZbP7MAK/instances/0LGD000000000IjOAI",
"ownerId": "005D0000001KvxRIAS",
"queryable" : false,
"hasDetailRows": false,
"completionDate": "2013-08-12T18:39:07Z"
}
]
SEE ALSO:
Instances List
Filter Reports on Demand
To get specific results on the fly, filter reports through the API. Filter changes made through the API does not affect the source report
definition. Using the API, you can filter with up to 20 custom field filters and add filter logic (such as AND, OR). But standard filters (such
as range), filtering by row limit, and cross filters are unavailable.
Before you filter a report, it’s helpful to check these properties in the metadata that tell you if a field can be filtered, the values and criteria
you can filter by, and filters that already exist in the report.
• filterable
• filterValues
• dataTypeFilterOperatorMap
• reportFilters
You can filter reports during synchronous or asynchronous report runs by making a POST request to the Execute Sync or Execute Async
resource.
Example
In a POST request, an accounts report is filtered synchronously by these passing filters with filter logic in the metadata to the Execute
Sync resource.
1. Account Name not equal to Data Mart
2. Account Owner not equal to Admin User
3. Annual Revenue greater than "100,000"
4. Industry not equal to Manufacturing,Recreation
52
Examples: Reports REST API Resources
Filter Reports on Demand
Filter logic: (1 OR 4) AND 2 AND 3.
{
"reportMetadata": {
"name": "FilterAcctsReport",
"id": "00OD0000001cw27MAA",
"reportFormat": "SUMMARY",
"reportBooleanFilter": "(1OR4)AND2AND3",
"reportFilters": [
{
"value": "DataMart",
"operator": "notEqual",
"column": "ACCOUNT.NAME"
},
{
"value": "AdminUser",
"operator": "notEqual",
"column": "USERS.NAME"
},
{
"value": "\"100,000\"",
"operator": "greaterThan",
"column": "SALES"
},
{
"value": "Manufacturing,Recreation",
"operator": "notEqual",
"column": "INDUSTRY"
}
],
"detailColumns": [
"RATING",
"LAST_UPDATE",
"SALES"
],
"developerName": "Filter_Accts_Report",
"reportType": {
"type": "AccountList",
"label": "Accounts"
},
"currency": null,
"aggregates": [
"s!SALES",
"RowCount"
],
"groupingsDown": [
{
"name": "USERS.NAME",
"sortAggregate": "s!SALES",
"sortOrder": "Desc",
"dateGranularity": "None"
},
{
"name": "ACCOUNT.NAME",
"sortAggregate": null,
53
Examples: Reports REST API Resources
Filter Reports on Demand
"sortOrder": "Asc",
"dateGranularity": "None"
},
{
"name": "DUE_DATE",
"sortAggregate": null,
"sortOrder": "Asc",
"dateGranularity": "Month"
}
],
"groupingsAcross": []
}
}
In response to the POST request, the report returns data that meets the given criteria.
{
"hasDetailRows": false,
"attributes": {
"describeUrl": "/services/data/v29.0/analytics/reports/00OD0000001cw27MAA/describe",
"instancesUrl":
"/services/data/v29.0/analytics/reports/00OD0000001cw27MAA/instances",
"type": "Report",
"reportName": "Filter Accts Report",
"reportId": "00OD0000001cw27MAA"
},
"factMap": {
"1_0!T": {
"aggregates": [
{
"value": 56000000,
"label": "$56,000,000"
},
{
"value": 1,
"label": "1"
}
]
},
"7_1!T": {
"aggregates": [
{
"value": 24000000,
"label": "$24,000,000"
},
{
"value": 1,
"label": "1"
}
]
},
...
"allData": true,
"reportMetadata": {
54
Examples: Reports REST API Resources
List Recently Viewed Reports
"name": "Filter Accts Report",
"id": "00OD0000001cw27MAA",
"reportFormat": "SUMMARY",
"reportBooleanFilter": "(1 OR 4) AND 2 AND 3",
"reportFilters": [
{
"value": "Data Mart",
"operator": "notEqual",
"column": "ACCOUNT.NAME"
},
{
"value": "Admin User",
"operator": "notEqual",
"column": "USERS.NAME"
},
{
"value": "\"100,000\"",
"operator": "greaterThan",
"column": "SALES"
},
{
"value": "Manufacturing,Recreation",
"operator": "notEqual",
"column": "INDUSTRY"
}
],
"detailColumns": [
"RATING",
"LAST_UPDATE",
"SALES"
],
...
}
}
SEE ALSO:
Execute Sync
List Recently Viewed Reports
Get up to 200 of the reports you most recently viewed in Salesforce by sending a GET request to the Report List resource.
Each report listing in the response has resource URLs to get metadata and run a report asynchronously or synchronously.
For a more extensive reports list, query the Report object using a SOQL query in a Salesforce API such as SOAP API or REST API. This SOQL
query, for example, returns all reports that are in matrix format: SELECT Description,Format,LastRunDate FROM
Report WHERE Format = 'MATRIX' ORDER BY Id ASC NULLS FIRST
55
Examples: Reports REST API Resources
List Recently Viewed Reports
Example
This GET request /services/data/v35.0/analytics/reports to the Report List resource returns a list of 5 recently
viewed reports.
[
{
"describeUrl" : "/services/data/v35.0/analytics/reports/00OR0000000K2OmMAK/describe",
"id" : "00OR0000000K2OmMAK",
"instancesUrl" : "/services/data/v35.0/analytics/reports/00OR0000000K2OmMAK/instances",
"name" : "Pipeline By Industry",
"url" : "/services/data/v35.0/analytics/reports/00OR0000000K2OmMAK" },
{
"describeUrl" : "/services/data/v35.0/analytics/reports/00OR0000000OFXeMAO/describe",
"id" : "00OR0000000OFXeMAO",
"instancesUrl" : "/services/data/v35.0/analytics/reports/00OR0000000OFXeMAO/instances",
"name" : "My Open Pipeline",
"url" : "/services/data/v35.0/analytics/reports/00OR0000000OFXeMAO" },
{
"describeUrl" : "/services/data/v35.0/analytics/reports/00OR0000000K2UeMAK/describe",
"id" : "00OR0000000K2UeMAK",
"instancesUrl" : "/services/data/v35.0/analytics/reports/00OR0000000K2UeMAK/instances",
"name" : "Deals Closing This Quarter",
"url" : "/services/data/v35.0/analytics/reports/00OR0000000K2UeMAK" },
{
"describeUrl" : "/services/data/v35.0/analytics/reports/00OR0000000OFHoMAO/describe",
"id" : "00OR0000000OFHoMAO",
"instancesUrl" : "/services/data/v35.0/analytics/reports/00OR0000000OFHoMAO/instances",
"name" : "Sample Report: # of Opportunities",
"url" : "/services/data/v35.0/analytics/reports/00OR0000000OFHoMAO" },
{
"describeUrl" : "/services/data/v35.0/analytics/reports/00OR0000000JdVOMA0/describe",
"id" : "00OR0000000JdVOMA0",
"instancesUrl" : "/services/data/v35.0/analytics/reports/00OR0000000JdVOMA0/instances",
"name" : "My Leads rpt",
"url" : "/services/data/v35.0/analytics/reports/00OR0000000JdVOMA0" }
]
SEE ALSO:
Report List
56
Examples: Reports REST API Resources
Decode the Fact Map
Decode the Fact Map
Depending on how you run a report, the fact map in the report results can contain values for only summary or both summary and
detailed data. The fact map values are expressed as keys, which you can programmatically use to visualize the report data. Fact map
keys provide an index into each section of a fact map, from which you can access summary and detailed data.
The pattern for the fact map keys varies by report format as shown in this table.
Report
format
Fact map key pattern
Tabular
T!T: The grand total of a report. Both record data values and the grand total are represented by this key.
Summary
!T: T refers to the row grand total.
Matrix
!.
Each item in a row or column grouping is numbered starting with 0. Here are some examples of fact map keys:
Fact Map
Key
Description
0!T
The first item in the first-level grouping.
1!T
The second item in the first-level grouping.
0_0!T
The first item in the first-level grouping and the first item in the second-level grouping.
0_1!T
The first item in the first-level grouping and the second item in the second-level grouping.
Let’s look at examples of how fact map keys represent data as it appears in a Salesforce tabular, summary, or matrix report.
Tabular Report Fact Map
Here’s an example of an opportunities report in tabular format. Since tabular reports don’t have groupings, all of the record level data
and summaries are expressed by the T!T key, which refers to the grand total.
57
Examples: Reports REST API Resources
Decode the Fact Map
Summary Report Fact Map
This example shows how the values in a summary report are represented in the fact map.
Fact Map Key
Description
0!T
Summary for the value of opportunities in the Prospecting stage.
1_0!T
Summary of the probabilities for the Manufacturing opportunities in the Needs Analysis stage.
58
Examples: Reports REST API Resources
Get Report Data without Saving Changes to or Creating a
Report
Matrix Report Fact Map
Here’s an example of some fact map keys for data in a matrix opportunities report with a couple of row and column groupings.
Fact Map Key
Description
0!0
Total opportunity amount in the Prospecting stage in Q4 2010.
0_0!0_0
Total opportunity amount in the Prospecting stage in the Manufacturing sector in October 2010.
2_1!1_1
Total value of opportunities in the Value Proposition stage in the Technology sector in February 2011.
T!T
Grand total summary for the report.
SEE ALSO:
Execute Sync
Execute Async
Get Report Data without Saving Changes to or Creating a Report
Run a report without creating a report or changing an existing one by making a POST request to the query resource. Get report data
without filling up your org with unnecessary reports.
Example
Get report data using the query resource.
/services/data/v37.0/analytics/reports/query
Include report criteria as reportMetadata in the POST request body. This POST request gets data about Opportunities:
{
"reportMetadata" : {
"aggregates" : [ "RowCount" ],
"chart" : null,
59
Examples: Reports REST API Resources
Get Report Data without Saving Changes to or Creating a
Report
"crossFilters" : [ ],
"currency" : null,
"description" : null,
"detailColumns" : [ "OPPORTUNITY_NAME", "TYPE", "LEAD_SOURCE", "AMOUNT", "CLOSE_DATE",
"NEXT_STEP", "STAGE_NAME", "PROBABILITY", "FISCAL_QUARTER", "AGE", "CREATED_DATE",
"FULL_NAME", "ROLLUP_DESCRIPTION", "ACCOUNT_NAME" ],
"developerName" : "OpportunityReport",
"division" : null,
"folderId" : "00DD000000086ujMAA",
"groupingsAcross" : [ ],
"groupingsDown" : [ ],
"hasDetailRows" : true,
"hasRecordCount" : true,
"historicalSnapshotDates" : [ ],
"id" : "00OD0000001leVCMAY",
"name" : "Matrix",
"reportBooleanFilter" : null,
"reportFilters" : [ ],
"reportFormat" : "MATRIX",
"reportType" : {
"label" : "Opportunities",
"type" : "Opportunity"
},
"scope" : "organization",
"showGrandTotal" : true,
"showSubtotals" : true,
"sortBy" : [ ],
"standardDateFilter" : {
"column" : "CLOSE_DATE",
"durationValue" : "CUSTOM",
"endDate" : null,
"startDate" : null
},
"standardFilters" : [ {
"name" : "open",
"value" : "all"
}, {
"name" : "probability",
"value" : ">0"
} ]
}
}
The response to the POST request returns report data, but doesn’t create or save a report.
{
"attributes" : {
"describeUrl" : "/services/data/v37.0/analytics/reports/null/describe",
"instancesUrl" : "/services/data/v37.0/analytics/reports/null/instances",
"reportId" : null,
"reportName" : "Matrix",
"type" : "Report"
},
"allData" : true,
"factMap" : {
60
Examples: Reports REST API Resources
Get Report Data without Saving Changes to or Creating a
Report
"T!T" : {
"aggregates" : [ {
"label" : "9",
"value" : 9
} ],
"rows" : [ {
"dataCells" : [ {
"label" : "salesforce.com - 5000 Widgets",
"value" : "006D000000CzmqYIAR"
}, {
"label" : "New Business",
"value" : "New Business"
}, {
"label" : "Advertisement",
"value" : "Advertisement"
}, {
"label" : "$500,000.00",
"value" : {
"amount" : 500000,
"currency" : null
}
}, {
"label" : "9/19/2013",
"value" : "2013-09-19"
}, {
"label" : "Closed!",
"value" : "Closed!"
}, {
"label" : "Closed Won",
"value" : "Closed Won"
}, {
"label" : "100%",
"value" : 100
}, {
"label" : "Q2-2007",
"value" : "Q2-2007"
}, {
"label" : "0",
"value" : 0
}, {
"label" : "1/4/2016",
"value" : "2016-01-04"
}, {
"label" : "Fred Williamson",
"value" : "005D0000001bV42IAE"
}, {
"label" : "-",
"value" : null
}, {
"label" : "Global Media",
"value" : "001D000000KtTTqIAN"
} ]
}, {
"dataCells" : [ {
61
Examples: Reports REST API Resources
Get Report Data without Saving Changes to or Creating a
Report
"label" : "salesforce.com - 500 Widgets",
"value" : "006D000000CzmqZIAR"
}, {
"label" : "Existing Business",
"value" : "Existing Business"
}, {
"label" : "Advertisement",
"value" : "Advertisement"
}, {
"label" : "$50,000.00",
"value" : {
"amount" : 50000,
"currency" : null
}
}, {
"label" : "9/19/2013",
"value" : "2013-09-19"
}, {
"label" : "Closed!",
"value" : "Closed!"
}, {
"label" : "Closed Won",
"value" : "Closed Won"
}, {
"label" : "100%",
"value" : 100
}, {
"label" : "Q2-2007",
"value" : "Q2-2007"
}, {
"label" : "0",
"value" : 0
}, {
"label" : "1/4/2016",
"value" : "2016-01-04"
}, {
"label" : "Fred Williamson",
"value" : "005D0000001bV42IAE"
}, {
"label" : "-",
"value" : null
}, {
"label" : "Global Media",
"value" : "001D000000KtTTqIAN"
} ]
}, {
"dataCells" : [ {
"label" : "Acme - 1,200 Widgets",
"value" : "006D000000CzmqbIAB"
}, {
"label" : "Existing Business",
"value" : "Existing Business"
}, {
"label" : "Trade Show",
62
Examples: Reports REST API Resources
Get Report Data without Saving Changes to or Creating a
Report
"value" : "Trade Show"
}, {
"label" : "$140,000.00",
"value" : {
"amount" : 140000,
"currency" : null
}
}, {
"label" : "10/22/2013",
"value" : "2013-10-22"
}, {
"label" : "Need estimate",
"value" : "Need estimate"
}, {
"label" : "Value Proposition",
"value" : "Value Proposition"
}, {
"label" : "50%",
"value" : 50
}, {
"label" : "Q2-2007",
"value" : "Q2-2007"
}, {
"label" : "134",
"value" : 134
}, {
"label" : "1/4/2016",
"value" : "2016-01-04"
}, {
"label" : "Fred Williamson",
"value" : "005D0000001bV42IAE"
}, {
"label" : "-",
"value" : null
}, {
"label" : "Acme",
"value" : "001D000000KtTTrIAN"
} ]
}, {
"dataCells" : [ {
"label" : "salesforce.com - 1,000 Widgets",
"value" : "006D000000CzmqeIAB"
}, {
"label" : "New Business",
"value" : "New Business"
}, {
"label" : "Advertisement",
"value" : "Advertisement"
}, {
"label" : "$100,000.00",
"value" : {
"amount" : 100000,
"currency" : null
}
63
Examples: Reports REST API Resources
Get Report Data without Saving Changes to or Creating a
Report
}, {
"label" : "10/22/2013",
"value" : "2013-10-22"
}, {
"label" : "Close the deal!",
"value" : "Close the deal!"
}, {
"label" : "Negotiation/Review",
"value" : "Negotiation/Review"
}, {
"label" : "90%",
"value" : 90
}, {
"label" : "Q2-2007",
"value" : "Q2-2007"
}, {
"label" : "134",
"value" : 134
}, {
"label" : "1/4/2016",
"value" : "2016-01-04"
}, {
"label" : "Fred Williamson",
"value" : "005D0000001bV42IAE"
}, {
"label" : "-",
"value" : null
}, {
"label" : "salesforce.com",
"value" : "001D000000KtTTsIAN"
} ]
}, {
"dataCells" : [ {
"label" : "Global Media - 400 Widgets",
"value" : "006D000000CzmqaIAB"
}, {
"label" : "New Business",
"value" : "New Business"
}, {
"label" : "Partner",
"value" : "Partner"
}, {
"label" : "$40,000.00",
"value" : {
"amount" : 40000,
"currency" : null
}
}, {
"label" : "11/20/2013",
"value" : "2013-11-20"
}, {
"label" : "-",
"value" : null
}, {
64
Examples: Reports REST API Resources
Get Report Data without Saving Changes to or Creating a
Report
"label" : "Id. Decision Makers",
"value" : "Id. Decision Makers"
}, {
"label" : "60%",
"value" : 60
}, {
"label" : "Q3-2007",
"value" : "Q3-2007"
}, {
"label" : "134",
"value" : 134
}, {
"label" : "1/4/2016",
"value" : "2016-01-04"
}, {
"label" : "Fred Williamson",
"value" : "005D0000001bV42IAE"
}, {
"label" : "-",
"value" : null
}, {
"label" : "Global Media",
"value" : "001D000000KtTTqIAN"
} ]
}, {
"dataCells" : [ {
"label" : "Acme - 600 Widgets",
"value" : "006D000000CzmqcIAB"
}, {
"label" : "New Business",
"value" : "New Business"
}, {
"label" : "Trade Show",
"value" : "Trade Show"
}, {
"label" : "$70,000.00",
"value" : {
"amount" : 70000,
"currency" : null
}
}, {
"label" : "12/18/2013",
"value" : "2013-12-18"
}, {
"label" : "Need estimate",
"value" : "Need estimate"
}, {
"label" : "Needs Analysis",
"value" : "Needs Analysis"
}, {
"label" : "20%",
"value" : 20
}, {
"label" : "Q3-2007",
65
Examples: Reports REST API Resources
Get Report Data without Saving Changes to or Creating a
Report
"value" : "Q3-2007"
}, {
"label" : "134",
"value" : 134
}, {
"label" : "1/4/2016",
"value" : "2016-01-04"
}, {
"label" : "Fred Williamson",
"value" : "005D0000001bV42IAE"
}, {
"label" : "-",
"value" : null
}, {
"label" : "Acme",
"value" : "001D000000KtTTrIAN"
} ]
}, {
"dataCells" : [ {
"label" : "salesforce.com - 2,000 Widgets",
"value" : "006D000000CzmqfIAB"
}, {
"label" : "Existing Business",
"value" : "Existing Business"
}, {
"label" : "Partner",
"value" : "Partner"
}, {
"label" : "$20,000.00",
"value" : {
"amount" : 20000,
"currency" : null
}
}, {
"label" : "12/20/2013",
"value" : "2013-12-20"
}, {
"label" : "Meet at Widget Conference",
"value" : "Meet at Widget Conference"
}, {
"label" : "Value Proposition",
"value" : "Value Proposition"
}, {
"label" : "50%",
"value" : 50
}, {
"label" : "Q3-2007",
"value" : "Q3-2007"
}, {
"label" : "134",
"value" : 134
}, {
"label" : "1/4/2016",
"value" : "2016-01-04"
66
Examples: Reports REST API Resources
Get Report Data without Saving Changes to or Creating a
Report
}, {
"label" : "Fred Williamson",
"value" : "005D0000001bV42IAE"
}, {
"label" : "-",
"value" : null
}, {
"label" : "salesforce.com",
"value" : "001D000000KtTTsIAN"
} ]
}, {
"dataCells" : [ {
"label" : "Acme - 200 Widgets",
"value" : "006D000000CzmqdIAB"
}, {
"label" : "Existing Business",
"value" : "Existing Business"
}, {
"label" : "Word of mouth",
"value" : "Word of mouth"
}, {
"label" : "$20,000.00",
"value" : {
"amount" : 20000,
"currency" : null
}
}, {
"label" : "2/20/2014",
"value" : "2014-02-20"
}, {
"label" : "Need estimate",
"value" : "Need estimate"
}, {
"label" : "Prospecting",
"value" : "Prospecting"
}, {
"label" : "10%",
"value" : 10
}, {
"label" : "Q4-2007",
"value" : "Q4-2007"
}, {
"label" : "134",
"value" : 134
}, {
"label" : "1/4/2016",
"value" : "2016-01-04"
}, {
"label" : "Fred Williamson",
"value" : "005D0000001bV42IAE"
}, {
"label" : "-",
"value" : null
}, {
67
Examples: Reports REST API Resources
"label" :
"value" :
} ]
}, {
"dataCells"
"label" :
"value" :
}, {
"label" :
"value" :
}, {
"label" :
"value" :
}, {
"label" :
"value" :
}, {
"label" :
"value" :
}, {
"label" :
"value" :
}, {
"label" :
"value" :
}, {
"label" :
"value" :
}, {
"label" :
"value" :
}, {
"label" :
"value" :
}, {
"label" :
"value" :
}, {
"label" :
"value" :
}, {
"label" :
"value" :
}, {
"label" :
"value" :
} ]
} ]
Get Report Data without Saving Changes to or Creating a
Report
"Acme",
"001D000000KtTTrIAN"
: [ {
"Fred",
"006D000000Czq0uIAB"
"-",
null
"-",
null
"-",
null
"2/26/2016",
"2016-02-26"
"-",
null
"Id. Decision Makers",
"Id. Decision Makers"
"60%",
60
"Q1-2016",
"Q1-2016"
"85",
85
"2/22/2016",
"2016-02-22"
"Fred Williamson",
"005D0000001bV42IAE"
"-",
null
"Fred",
"001D000000KtqzeIAB"
}
},
"groupingsAcross" : {
"groupings" : [ ]
},
"groupingsDown" : {
68
Examples: Reports REST API Resources
Get Report Data without Saving Changes to or Creating a
Report
"groupings" : [ ]
},
"hasDetailRows" : true,
"reportExtendedMetadata" : {
"aggregateColumnInfo" : {
"RowCount" : {
"dataType" : "int",
"label" : "Record Count"
}
},
"detailColumnInfo" : {
"OPPORTUNITY_NAME" : {
"dataType" : "string",
"label" : "Opportunity Name"
},
"TYPE" : {
"dataType" : "picklist",
"label" : "Type"
},
"LEAD_SOURCE" : {
"dataType" : "picklist",
"label" : "Lead Source"
},
"AMOUNT" : {
"dataType" : "currency",
"label" : "Amount"
},
"CLOSE_DATE" : {
"dataType" : "date",
"label" : "Close Date"
},
"NEXT_STEP" : {
"dataType" : "string",
"label" : "Next Step"
},
"STAGE_NAME" : {
"dataType" : "picklist",
"label" : "Stage"
},
"PROBABILITY" : {
"dataType" : "percent",
"label" : "Probability (%)"
},
"FISCAL_QUARTER" : {
"dataType" : "string",
"label" : "Fiscal Period"
},
"AGE" : {
"dataType" : "int",
"label" : "Age"
},
"CREATED_DATE" : {
"dataType" : "datetime",
"label" : "Created Date"
69
Examples: Reports REST API Resources
Get Report Data without Saving Changes to or Creating a
Report
},
"FULL_NAME" : {
"dataType" : "string",
"label" : "Opportunity Owner"
},
"ROLLUP_DESCRIPTION" : {
"dataType" : "string",
"label" : "Owner Role"
},
"ACCOUNT_NAME" : {
"dataType" : "string",
"label" : "Account Name"
}
},
"groupingColumnInfo" : { }
},
"reportMetadata" : {
"aggregates" : [ "RowCount" ],
"chart" : null,
"crossFilters" : [ ],
"currency" : null,
"description" : null,
"detailColumns" : [ "OPPORTUNITY_NAME", "TYPE", "LEAD_SOURCE", "AMOUNT", "CLOSE_DATE",
"NEXT_STEP", "STAGE_NAME", "PROBABILITY", "FISCAL_QUARTER", "AGE", "CREATED_DATE",
"FULL_NAME", "ROLLUP_DESCRIPTION", "ACCOUNT_NAME" ],
"developerName" : null,
"division" : null,
"folderId" : "00DD000000086ujMAA",
"groupingsAcross" : [ ],
"groupingsDown" : [ ],
"hasDetailRows" : true,
"hasRecordCount" : true,
"historicalSnapshotDates" : [ ],
"id" : null,
"name" : "Matrix",
"reportBooleanFilter" : null,
"reportFilters" : [ ],
"reportFormat" : "TABULAR",
"reportType" : {
"label" : "Opportunities",
"type" : "Opportunity"
},
"scope" : "organization",
"showGrandTotal" : true,
"showSubtotals" : true,
"sortBy" : [ ],
"standardDateFilter" : {
"column" : "CLOSE_DATE",
"durationValue" : "CUSTOM",
"endDate" : null,
"startDate" : null
},
"standardFilters" : [ {
"name" : "open",
70
Examples: Reports REST API Resources
Save Changes to Reports
"value" : "all"
}, {
"name" : "probability",
"value" : ">0"
} ]
}
}
Save Changes to Reports
Save changes to a report by sending a PATCH request to the Report resource.
Note: Saving a report deletes any running async report jobs because they will be obsolete.
Example
For report 00OD0000001cxIE, you want to change the report name to “myUpdatedReport” and change the folder that contains the
report. You save the changes to the report.
This PATCH request /services/data/v34.0/analytics/reports/00OD0000001cxIE to the Report resource updates
and saves the report.
{
"reportMetadata" : {
"name":"myUpdatedReport",
"folderId":"00DD00000007enH"}
}
The response to the PATCH request returns the following details about the updated, saved report.
{
"reportExtendedMetadata" : {
...
},
"reportMetadata" : {
"aggregates" : [ "RowCount" ],
"chart" : null,
"currency" : null,
"description" : null,
"detailColumns" : [
"USERS.NAME",
"ACCOUNT.NAME",
"TYPE",
"DUE_DATE",
"LAST_UPDATE",
"ADDRESS1_STATE" ],
"developerName" : "myreport",
"division" : null,
"folderId" : "00DD00000007enHMAQ",
"groupingsAcross" : [ ],
"groupingsDown" : [ ],
"hasDetailRows" : true,
"hasRecordCount" : true,
71
Examples: Reports REST API Resources
Clone Reports
"historicalSnapshotDates" : [ ],
"id" : "00OD0000001cxIEMAY",
"name" : "myUpdatedReport",
"reportBooleanFilter" : null,
"reportFilters" : [ ],
"reportFormat" : "TABULAR",
"reportType" : {
"label" : "Accounts",
"type" : "AccountList" },
"scope" : "user",
"showGrandTotal" : true,
"showSubtotals" : true,
"sortBy" : [ ],
"standardDateFilter" : {
"column" : "CREATED_DATE",
"durationValue" : "CUSTOM",
"endDate" : null,
"startDate" : null },
"standardFilters" : null },
"reportTypeMetadata" : {
...
}
}
Clone Reports
Creates a copy of a custom, standard, or public report by sending a POST request to the Report List resource.
Example
You want to clone report 00OD0000001cxIE and name the cloned report as "myNewReport."
This POST request /services/data/v34.0/analytics/reports?cloneId=00OD0000001cxIE to the Report List
resource clones the report.
{ "reportMetadata" :
{"name":"myNewReport"}
}
The response to the POST request returns the following details about the cloned report.
{
"reportExtendedMetadata" : {
...
},
"reportMetadata" : {
"aggregates" : [ "RowCount" ],
"chart" : null,
"currency" : null,
"description" : null,
"detailColumns" : [
"USERS.NAME",
"ACCOUNT.NAME",
72
Examples: Reports REST API Resources
Delete Reports
"TYPE",
"DUE_DATE",
"LAST_UPDATE",
"ADDRESS1_STATE" ],
"developerName" : "myreport2",
"division" : null,
"folderId" : "005D0000001UlszIAC",
"groupingsAcross" : [ ],
"groupingsDown" : [ ],
"hasDetailRows" : true,
"hasRecordCount" : true,
"historicalSnapshotDates" : [ ],
"id" : "00OD0000001jabSMAQ",
"name" : "myNewReport",
"reportBooleanFilter" : null,
"reportFilters" : [ ],
"reportFormat" : "TABULAR",
"reportType" : {
"label" : "Accounts",
"type" : "AccountList" },
"scope" : "user",
"showGrandTotal" : true,
"showSubtotals" : true,
"sortBy" : [ ],
"standardDateFilter" : {
"column" : "CREATED_DATE",
"durationValue" : "CUSTOM",
"endDate" : null,
"startDate" : null },
"standardFilters" : null },
"reportTypeMetadata" : {
...
}
}
Delete Reports
Delete a report by sending a DELETE request to the Report resource. Deleted reports are moved to the Recycle Bin.
Note: Deleting a report also cancels any running async report jobs and deletes all scheduled notifications.
Example
This DELETE request /services/data/v34.0/analytics/reports/00OD0000001cxIE to the Report resource deletes
the report and returns a 204 HTTP response code with no content in the response body.
73
CHAPTER 3
In this chapter ...
•
Get List of Recently
Used Dashboards
•
Get Dashboard
Results
•
Filter Dashboard
Results
Examples: Dashboards REST API Resources
The Dashboards API is designed to let you access and refresh dashboards easily. Use the API to:
• Get List of Recently Used Dashboards
Get a list of dashboards with URLs to access status and results.
• Get Dashboard Results
Get dashboard metadata, data, and status.
• Filter Dashboard Results
•
Get Dashboard
Status
•
Refresh a Dashboard
•
Save a Dashboard
•
Return Details About
Dashboard
Components
• Refresh a Dashboard
•
Get Dashboard
Metadata
• Save a Dashboard
•
Clone a Dashboard
•
Delete a Dashboard
Filter dashboard results, status, or refresh requests.
• Get Dashboard Status
Get dashboard refresh status.
Trigger a dashboard refresh.
Save changes to a dashboard.
• Clone a Dashboard
Make a copy of an existing dashboard.
• Delete a Dashboard
Clean up unused and obsolete dashboards.
74
Examples: Dashboards REST API Resources
Get List of Recently Used Dashboards
Get List of Recently Used Dashboards
You can get a list of recently used dashboards by using the Dashboard resource.
Use a GET request on the Dashboard List resource to retrieve a list of recently used dashboards. The list is sorted by the date when the
dashboard was last refreshed.
Example Usage
/services/data/v35.0/analytics/dashboards
Example Response Body
In this case, the Dashboard resource returns information for two dashboards. Each URL handle stores the status or results for the
dashboard.
[ {
"id" : "01ZD00000007QeuMAE",
"name" : "Adoption Dashboard",
"statusUrl" : "/services/data/v35.0/analytics/dashboards/01ZD00000007QeuMAE/status",
"url" : "/services/data/v35.0/analytics/dashboards/01ZD00000007QeuMAE"
}, {
"id" : "01ZD00000007QevMAE",
"name" : "Global Sales Dashboard",
"statusUrl" : "/services/data/v35.0/analytics/dashboards/01ZD00000007QevMAE/status",
"url" : "/services/data/v35.0/analytics/dashboards/01ZD00000007QevMAE"
} ]
SEE ALSO:
Dashboard List
Get Dashboard Results
You can get dashboard metadata, data, and status by sending a GET request to the Dashboard Results resource.
Use a GET request to the Dashboard Results resource to retrieve metadata, data, and status for a dashboard and its components. The
results response contains:
• Metadata: information about the dashboard as a whole, including the dashboard ID, name, component metadata, and any dashboard
filters.
• Data: underlying report data for each component, filtered by the optional filter parameters. For more information about filtering,
see Filter Dashboard Results.
• Status: data and refresh status for each component of the dashboard. The data status can be NODATA, DATA, or ERROR. If an
error occurs, the component status will contain additional properties with the error code, message, and severity. The refresh status
can be IDLE, if components are finished running, or RUNNING, if components are still being refreshed.
Example Usage
/services/data/v31.0/analytics/dashboards/01ZD00000007S89MAE
Example Response Body
{
"componentData" : [ {
75
Examples: Dashboards REST API Resources
Get Dashboard Results
"componentId" : "01aD0000000a36LIAQ",
"reportResult" : {
"attributes" : null,
"allData" : true,
"factMap" : {
"T!T" : {
"aggregates" : [ {
"label" : "USD 67,043,365.50",
"value" : 67043365.50166918337345123291015625
} ]
},
"0!T" : {
"aggregates" : [ {
"label" : "USD 10,083.33",
"value" : 10083.333333333333939663134515285491943359375
} ]
},
"1!T" : {
"aggregates" : [ {
"label" : "USD 25,016,768.67",
"value" : 25016768.670066006481647491455078125
} ]
},
"2!T" : {
"aggregates" : [ {
"label" : "USD 42,016,513.50",
"value" : 42016513.49826984107494354248046875
} ]
}
},
"groupingsAcross" : null,
"groupingsDown" : {
"groupings" : [ {
"groupings" : [ ],
"key" : "0",
"label" : "-",
"value" : null
}, {
"groupings" : [ ],
"key" : "1",
"label" : "Existing Business",
"value" : "Existing Business"
}, {
"groupings" : [ ],
"key" : "2",
"label" : "New Business",
"value" : "New Business"
} ]
},
"hasDetailRows" : false,
"reportExtendedMetadata" : {
"aggregateColumnInfo" : {
"s!AMOUNT" : {
"acrossGroupingContext" : null,
76
Examples: Dashboards REST API Resources
Get Dashboard Results
"dataType" : "currency",
"downGroupingContext" : null,
"label" : "Sum of Amount"
}
},
"detailColumnInfo" : { },
"groupingColumnInfo" : {
"TYPE" : {
"dataType" : "picklist",
"groupingLevel" : 0,
"label" : "Type"
}
}
},
"reportMetadata" : {
"aggregates" : [ "s!AMOUNT" ],
"chart" : null,
"currency" : "USD",
"description" : null,
"detailColumns" : [ ],
"developerName" : "Simple_Test",
"division" : null,
"folderId" : "00lR0000000M8IiIAK",
"groupingsAcross" : [ ],
"groupingsDown" : [ {
"dateGranularity" : "None",
"name" : "TYPE",
"sortAggregate" : null,
"sortOrder" : "Asc"
} ],
"hasDetailRows" : false,
"hasRecordCount" : true,
"historicalSnapshotDates" : [ ],
"id" : "00OD0000001g2nWMAQ",
"name" : "Simple Test",
"reportBooleanFilter" : null,
"reportFilters" : [ ],
"reportFormat" : "SUMMARY",
"reportType" : {
"label" : "Opportunities",
"type" : "Opportunity"
},
"scope" : "organization",
"showGrandTotal" : true,
"showSubtotals" : true,
"sortBy" : [ ],
"standardDateFilter" : { "column" : "CLOSE_DATE", "durationValue" : "CUSTOM",
"endDate" : null, "startDate" : null },
"standardFilters" : [
{ "name" : "open", "value" : "all" },
{ "name" : "probability", "value" : ">0" } ]
}
},
"status" : {
77
Examples: Dashboards REST API Resources
Get Dashboard Results
"dataStatus" : "DATA",
"errorCode" : null,
"errorMessage" : null,
"errorSeverity" : null,
"refreshDate" : "2014-04-09T00:28:16.000+0000",
"refreshStatus" : "IDLE"
}
} ],
"dashboardMetadata" : {
"attributes" : {
"dashboardId" : "01ZD00000007S89MAE",
"dashboardName" : "Simple Dashboard",
"statusUrl" : "/services/data/v31.0/analytics/dashboards/01ZD00000007S89MAE/status",
"type" : "Dashboard"
},
"canChangeRunningUser" : false,
"components" : [ {
"componentData" : 0,
"footer" : null,
"header" : null,
"id" : "01aD0000000a36LIAQ",
"properties" : {
"aggregates" : [ { "name" : "s!AMOUNT" } ],
"autoSelectColumns" : false,
"groupings" : null,
"maxRows" : null,
"sort" : { "column" : "TYPE", "sortOrder" : "asc" },
"useReportChart" : false,
"visualizationProperties" : {
"breakPoints" : [ {
"aggregateName" : "s!AMOUNT",
"breaks" : [
{ "color" : "000000", "lowerBound" : null, "upperBound" : -1 },
{ "color" : "000000", "lowerBound" : -1, "upperBound" : 0 },
{ "color" : "000000", "lowerBound" : 0, "upperBound" : null } ]
} ],
"metricLabel" : null },
"visualizationType" : "Metric" },
"reportId" : "00OD0000001g2nWMAQ",
"title" : null,
"type" : "Report"
} ],
"description" : null,
"developerName" : "Simple_Dashboard",
"filters" : [ {
"name" : "Amount",
"options" : [ {
"alias" : null,
"endValue" : null,
"id" : "0ICD00000004CBiOAM",
"operation" : "greaterThan",
"startValue" : null,
78
Examples: Dashboards REST API Resources
Filter Dashboard Results
"value" : "USD 2000000"
} ],
"selectedOption" : null
} ],
"folderId" : "00lR0000000DrojIAC",
"id" : "01ZD00000007S89MAE",
"layout" : {
"columns" : [ {
"components" : [ 0 ]
} ]
},
"name" : "Simple Dashboard",
"runningUser" : {
"displayName" : "Allison Wheeler",
"id" : "005D00000016V2qIAE"
}
}
}
SEE ALSO:
Dashboard Results
Filter Dashboard Results
You can filter dashboard results, status, or refresh requests, by using filter parameters.
Dashboard results are always unfiltered, unless you have specified filter parameters in your request. When requesting a dashboard result,
status, or refresh, you can specify up to three optional filter parameters: filter1, filter2 and filter3. These parameters allow
you to apply filter options, which can be selected from the filters that are currently defined for the dashboard. Filters can be applied to
the following requests:
• A GET request on the Dashboard Results resource: returns data filtered by the specified parameters.
• A PUT request on the Dashboard Results resource: refreshes the data that has been filtered by the specified parameters.
• A GET request on the Dashboard Status resource: returns status for the data that has been filtered by the specified parameters.
Example Usage
A dashboard with one filter ("Country") and two options ("United States" and "Canada") appears like this in the dashboard metadata:
{
"dashboardMetadata" : {
...
"filters" : [ {
"name" : "Country",
"options" : [ {
"id" : "0ICxx0000000001GAA",
"alias" : "United States",
"operation" : "equals",
"value" : "US",
"startValue" : null,
"endValue" : null
} ], [ {
79
Examples: Dashboards REST API Resources
Get Dashboard Status
"id" : "0ICxx0000000002GAA",
"alias" : "Canada",
"operation" : "equals",
"value" : "CA",
"startValue" : null,
"endValue" : null
} ],
...
}
To retrieve dashboard results with a filter of "Country equals Canada" you could make the following GET request:
/services/data/v31.0/analytics/dashboards/01Zxx0000000000000?filter1=0ICxx0000000002GAA
SEE ALSO:
Dashboard Results
Dashboard Status
Get Dashboard Status
You can get the dashboard status by sending a GET request to the Dashboard Status resource.
Use the Dashboard Status resource to retrieve a status for each component of the dashboard. The components are listed in the order in
which they were refreshed. The request returns IDLE if a component is not currently being refreshed, and RUNNING if a component
is currently being refreshed.
Example Usage
To retrieve the status for a dashboard with an ID of 01ZD00000007QevMAE, you could make the following request:
/services/data/v31.0/analytics/dashboards/01ZD00000007QevMAE/status
Example Response Body
The response contains the status for each component, along with the refresh date and time:
{
"componentStatus"
"componentId" :
"refreshDate" :
"refreshStatus"
}, {
"componentId" :
"refreshDate" :
"refreshStatus"
}, {
"componentId" :
"refreshDate" :
"refreshStatus"
: [ {
"01aD0000000J7M7",
"2014-03-10T17:26:07.000+0000",
: "IDLE"
"01aD0000000J7M9",
"2014-03-10T17:26:08.000+0000",
: "IDLE"
"01aD0000000J7MB",
"2014-03-10T17:26:09.000+0000",
: "IDLE"
80
Examples: Dashboards REST API Resources
Refresh a Dashboard
} ]
}
SEE ALSO:
Dashboard Status
Refresh a Dashboard
You can refresh a dashboard by using a PUT Dashboard Results request.
Use a PUT request on the Dashboard Results resource to trigger a refresh of a dashboard. The refresh response returns the URL of the
status resource after the refresh is triggered. If filter parameters are included in the PUT request, only the filtered data will be refreshed.
For more information on filtering, see Filter Dashboard Results.
Example Usage
The following PUT request refreshes the dashboard with the ID of 01ZD00000007S89MAE.
/services/data/v31.0/analytics/dashboards/01ZD00000007S89MAE
Example Request Body
None required.
Example Response Body
The response contains the status URL for the refreshed dashboard:
{
"statusUrl" : "/services/data/v31.0/analytics/dashboards/01ZD00000007S89MAE/status"
}
SEE ALSO:
Dashboard Results
Save a Dashboard
You can save changes to a dashboard by sending a PATCH request to the Dashboard Results resource.
Use a PATCH request on the Dashboard Results resource to save changes to a dashboard.
Example Usage
/services/data/v31.0/analytics/dashboards/01ZD00000007S89MAE
Example Request Body
{
"dashboardMetadata" : {
"name" : "Sales Dashboard",
}
}
81
Examples: Dashboards REST API Resources
Save a Dashboard
Example Response Body
{
"componentData" : [ {
"componentId" : "01aD0000000a36LIAQ",
"reportResult" : {
"attributes" : null,
"allData" : true,
"factMap" : {
"T!T" : {
"aggregates" : [ {
"label" : "USD 67,043,365.50",
"value" : 67043365.50166918337345123291015625
} ]
},
"0!T" : {
"aggregates" : [ {
"label" : "USD 10,083.33",
"value" : 10083.333333333333939663134515285491943359375
} ]
},
"1!T" : {
"aggregates" : [ {
"label" : "USD 25,016,768.67",
"value" : 25016768.670066006481647491455078125
} ]
},
"2!T" : {
"aggregates" : [ {
"label" : "USD 42,016,513.50",
"value" : 42016513.49826984107494354248046875
} ]
}
},
"groupingsAcross" : null,
"groupingsDown" : {
"groupings" : [ {
"groupings" : [ ],
"key" : "0",
"label" : "-",
"value" : null
}, {
"groupings" : [ ],
"key" : "1",
"label" : "Existing Business",
"value" : "Existing Business"
}, {
"groupings" : [ ],
"key" : "2",
"label" : "New Business",
"value" : "New Business"
} ]
},
"hasDetailRows" : false,
82
Examples: Dashboards REST API Resources
Save a Dashboard
"reportExtendedMetadata" : {
"aggregateColumnInfo" : {
"s!AMOUNT" : {
"acrossGroupingContext" : null,
"dataType" : "currency",
"downGroupingContext" : null,
"label" : "Sum of Amount"
}
},
"detailColumnInfo" : { },
"groupingColumnInfo" : {
"TYPE" : {
"dataType" : "picklist",
"groupingLevel" : 0,
"label" : "Type"
}
}
},
"reportMetadata" : {
"aggregates" : [ "s!AMOUNT" ],
"chart" : null,
"currency" : "USD",
"description" : null,
"detailColumns" : [ ],
"developerName" : "Simple_Test",
"division" : null,
"folderId" : "00lR0000000M8IiIAK",
"groupingsAcross" : [ ],
"groupingsDown" : [ {
"dateGranularity" : "None",
"name" : "TYPE",
"sortAggregate" : null,
"sortOrder" : "Asc"
} ],
"hasDetailRows" : false,
"hasRecordCount" : true,
"historicalSnapshotDates" : [ ],
"id" : "00OD0000001g2nWMAQ",
"name" : "Simple Test",
"reportBooleanFilter" : null,
"reportFilters" : [ ],
"reportFormat" : "SUMMARY",
"reportType" : {
"label" : "Opportunities",
"type" : "Opportunity"
},
"scope" : "organization",
"showGrandTotal" : true,
"showSubtotals" : true,
"sortBy" : [ ],
"standardDateFilter" : { "column" : "CLOSE_DATE", "durationValue" : "CUSTOM",
"endDate" : null, "startDate" : null },
"standardFilters" : [
{ "name" : "open", "value" : "all" },
83
Examples: Dashboards REST API Resources
Save a Dashboard
{ "name" : "probability", "value" : ">0" } ]
}
},
"status" : {
"dataStatus" : "DATA",
"errorCode" : null,
"errorMessage" : null,
"errorSeverity" : null,
"refreshDate" : "2014-04-09T00:28:16.000+0000",
"refreshStatus" : "IDLE"
}
} ],
"dashboardMetadata" : {
"attributes" : {
"dashboardId" : "01ZD00000007S89MAE",
"dashboardName" : "Service Dept Dashboard",
"statusUrl" : "/services/data/v31.0/analytics/dashboards/01ZD00000007S89MAE/status",
"type" : "Dashboard"
},
"canChangeRunningUser" : false,
"components" : [ {
"componentData" : 0,
"footer" : null,
"header" : null,
"id" : "01aD0000000a36LIAQ",
"properties" : {
"aggregates" : [ { "name" : "s!AMOUNT" } ],
"autoSelectColumns" : false,
"groupings" : null,
"maxRows" : null,
"sort" : { "column" : "TYPE", "sortOrder" : "asc" },
"useReportChart" : false,
"visualizationProperties" : {
"breakPoints" : [ {
"aggregateName" : "s!AMOUNT",
"breaks" : [
{ "color" : "000000", "lowerBound" : null, "upperBound" : -1 },
{ "color" : "000000", "lowerBound" : -1, "upperBound" : 0 },
{ "color" : "000000", "lowerBound" : 0, "upperBound" : null } ]
} ],
"metricLabel" : null },
"visualizationType" : "Metric" },
"reportId" : "00OD0000001g2nWMAQ",
"title" : null,
"type" : "Report"
} ],
"description" : null,
"developerName" : "Simple_Dashboard",
"filters" : [ {
"name" : "Amount",
"options" : [ {
"alias" : null,
84
Examples: Dashboards REST API Resources
Return Details About Dashboard Components
"endValue" : null,
"id" : "0ICD00000004CBiOAM",
"operation" : "greaterThan",
"startValue" : null,
"value" : "USD 2000000"
} ],
"selectedOption" : null
} ],
"folderId" : "00lR0000000DrojIAC",
"id" : "01ZD00000007S89MAE",
"layout" : {
"columns" : [ {
"components" : [ 0 ]
} ]
},
"name" : "Simple Dashboard",
"runningUser" : {
"displayName" : "Allison Wheeler",
"id" : "005D00000016V2qIAE"
}
}
}
Return Details About Dashboard Components
Get details about one or more dashboard components using a POST request.
Use a POST request on the Dashboard Results resource to get details about one or more dashboard components. Specify which dashboard
components you want details about using componentIds in the request body. Available in API versions 36.0 and later.
Example Usage
/services/data/v36.0/analytics/dashboards/01ZR00000008h2EMAQ
Example Request Body
{
"componentIds": ["01aR00000005aT4IAI", "01aR00000005aT5IAI"]
}
Example Response Body
{
"attributes" : {
"dashboardId" : "01ZR00000008h2EMAQ",
"dashboardName" : "Liz's Sales Manager Dashboard",
"describeUrl" :
"/services/data/v37.0/analytics/dashboards/01ZR00000008h2EMAQ/describe",
"statusUrl" : "/services/data/v37.0/analytics/dashboards/01ZR00000008h2EMAQ/status",
"type" : "Dashboard"
},
"componentData" : [ {
"componentId" : "01aR00000005aT4IAI",
"reportResult" : {
85
Examples: Dashboards REST API Resources
Return Details About Dashboard Components
"attributes" : null,
"allData" : true,
"factMap" : {
"0!T" : {
"aggregates" : [ {
"label" : "$10,000.00",
"value" : 10000
} ]
},
"1!T" : {
"aggregates" : [ {
"label" : "$110,000.00",
"value" : 110000
} ]
},
"0_0!T" : {
"aggregates" : [ {
"label" : "$10,000.00",
"value" : 10000
} ]
},
"2_2!T" : {
"aggregates" : [ {
"label" : "$143.00",
"value" : 143
} ]
},
"2!T" : {
"aggregates" : [ {
"label" : "$400,398.00",
"value" : 400398
} ]
},
"0_1!T" : {
"aggregates" : [ {
"label" : "$0.00",
"value" : 0
} ]
},
"2_3!T" : {
"aggregates" : [ {
"label" : "$100,017.00",
"value" : 100017
} ]
},
"T!T" : {
"aggregates" : [ {
"label" : "$520,398.00",
"value" : 520398
} ]
},
"2_0!T" : {
"aggregates" : [ {
"label" : "$138.00",
86
Examples: Dashboards REST API Resources
Return Details About Dashboard Components
"value" : 138
} ]
},
"1_0!T" : {
"aggregates" : [ {
"label" : "$110,000.00",
"value" : 110000
} ]
},
"2_1!T" : {
"aggregates" : [ {
"label" : "$300,100.00",
"value" : 300100
} ]
}
},
"groupingsAcross" : null,
"groupingsDown" : {
"groupings" : [ {
"groupings" : [ {
"groupings" : [ ],
"key" : "0_0",
"label" : "-",
"value" : null
}, {
"groupings" : [ ],
"key" : "0_1",
"label" : "-",
"value" : null
} ],
"key" : "0",
"label" : "January 2016",
"value" : "January 2016"
}, {
"groupings" : [ {
"groupings" : [ ],
"key" : "1_0",
"label" : "-",
"value" : null
} ],
"key" : "1",
"label" : "February 2016",
"value" : "February 2016"
}, {
"groupings" : [ {
"groupings" : [ ],
"key" : "2_0",
"label" : "-",
"value" : null
}, {
"groupings" : [ ],
"key" : "2_1",
"label" : "-",
"value" : null
87
Examples: Dashboards REST API Resources
Return Details About Dashboard Components
}, {
"groupings" : [ ],
"key" : "2_2",
"label" : "-",
"value" : null
}, {
"groupings" : [ ],
"key" : "2_3",
"label" : "-",
"value" : null
} ],
"key" : "2",
"label" : "March 2016",
"value" : "March 2016"
} ]
},
"hasDetailRows" : false,
"reportExtendedMetadata" : {
"aggregateColumnInfo" : {
"s!AMOUNT" : {
"dataType" : "currency",
"label" : "Sum of Amount"
}
},
"detailColumnInfo" : { },
"groupingColumnInfo" : {
"ACCOUNT_NAME" : {
"dataType" : "string",
"groupingLevel" : 0,
"label" : "Account Name"
},
"CLOSE_DATE" : {
"dataType" : "date",
"groupingLevel" : 0,
"label" : "Close Date"
}
}
},
"reportMetadata" : {
"aggregates" : [ "s!AMOUNT" ],
"buckets" : [ {
"bucketType" : "picklist",
"devloperName" : "BucketField_47575792",
"label" : "Industry",
"nullTreatedAsZero" : false,
"otherBucketLabel" : null,
"sourceColumnName" : "INDUSTRY",
"values" : [ {
"label" : "Technology",
"rangeUpperBound" : null,
"sourceDimensionValues" : [ "Agriculture", "Apparel", "Banking",
"Biotechnology", "Chemicals", "Communications", "Construction", "Consulting", "Education",
"Electronics" ]
}, {
88
Examples: Dashboards REST API Resources
Return Details About Dashboard Components
"label" : "Energy",
"rangeUpperBound" : null,
"sourceDimensionValues" : [ "Energy", "Engineering", "Entertainment",
"Environmental", "Finance", "Food & Beverage", "Government", "Healthcare", "Hospitality",
"Insurance", "Machinery", "Manufacturing" ]
}, {
"label" : "Healthcare",
"rangeUpperBound" : null,
"sourceDimensionValues" : [ "Media", "Not For Profit", "Other", "Recreation",
"Retail", "Shipping", "Technology", "Telecommunications", "Transportation", "Utilities"
]
} ]
}, {
"bucketType" : "picklist",
"devloperName" : "BucketField_36625466",
"label" : "Stage",
"nullTreatedAsZero" : false,
"otherBucketLabel" : null,
"sourceColumnName" : "STAGE_NAME",
"values" : [ {
"label" : "Early",
"rangeUpperBound" : null,
"sourceDimensionValues" : [ "Prospecting", "Qualification", "Needs Analysis"
]
}, {
"label" : "Late",
"rangeUpperBound" : null,
"sourceDimensionValues" : [ "Value Proposition", "Id. Decision Makers",
"Perception Analysis", "Proposal/Price Quote", "Negotiation/Review" ]
}, {
"label" : "Won",
"rangeUpperBound" : null,
"sourceDimensionValues" : [ "Closed Won" ]
}, {
"label" : "Lost",
"rangeUpperBound" : null,
"sourceDimensionValues" : [ "Closed Lost" ]
} ]
} ],
"chart" : null,
"crossFilters" : [ ],
"currency" : null,
"description" : null,
"detailColumns" : [ ],
"developerName" : "Deals_Closing_This_Quarter",
"division" : null,
"folderId" : "00lR0000000M8IiIAK",
"groupingsAcross" : [ ],
"groupingsDown" : [ {
"dateGranularity" : "None",
"name" : "ACCOUNT_NAME",
"sortAggregate" : null,
"sortOrder" : "Asc"
}, {
89
Examples: Dashboards REST API Resources
Return Details About Dashboard Components
"dateGranularity" : "Month",
"name" : "CLOSE_DATE",
"sortAggregate" : null,
"sortOrder" : "Asc"
} ],
"hasDetailRows" : false,
"hasRecordCount" : true,
"historicalSnapshotDates" : [ ],
"id" : "00OR0000000K2UeMAK",
"name" : "Deals Closing This Quarter",
"reportBooleanFilter" : null,
"reportFilters" : [ {
"column" : "BucketField_36625466",
"isRunPageEditable" : true,
"operator" : "equals",
"value" : "Early,Late"
}, {
"column" : "TYPE",
"isRunPageEditable" : true,
"operator" : "equals",
"value" : "Existing Business,New Business"
} ],
"reportFormat" : "SUMMARY",
"reportType" : {
"label" : "Opportunities",
"type" : "Opportunity"
},
"scope" : "organization",
"showGrandTotal" : true,
"showSubtotals" : true,
"sortBy" : [ ],
"standardDateFilter" : {
"column" : "CLOSE_DATE",
"durationValue" : "THIS_FISCAL_QUARTER",
"endDate" : "2016-06-30",
"startDate" : "2016-04-01"
},
"standardFilters" : [ {
"name" : "open",
"value" : "all"
}, {
"name" : "probability",
"value" : ">0"
} ]
}
},
"status" : {
"dataStatus" : "DATA",
"errorCode" : null,
"errorMessage" : null,
"errorSeverity" : null,
"refreshDate" : "2016-03-22T18:24:39.000+0000",
"refreshStatus" : "IDLE"
}
90
Examples: Dashboards REST API Resources
Return Details About Dashboard Components
}, {
"componentId" : "01aR00000005aT5IAI",
"reportResult" : {
"attributes" : null,
"allData" : true,
"factMap" : {
"0!T" : {
"aggregates" : [ {
"label" : "$634,493.00",
"value" : 634493
} ]
},
"1!T" : {
"aggregates" : [ {
"label" : "$590,036.00",
"value" : 590036
} ]
},
"0_0!T" : {
"aggregates" : [ {
"label" : "$14.00",
"value" : 14
} ]
},
"2!T" : {
"aggregates" : [ {
"label" : "$1,330,035.00",
"value" : 1330035
} ]
},
"0_1!T" : {
"aggregates" : [ {
"label" : "$36,021.00",
"value" : 36021
} ]
},
"0_2!T" : {
"aggregates" : [ {
"label" : "$5,000.00",
"value" : 5000
} ]
},
"1_3!T" : {
"aggregates" : [ {
"label" : "$500,000.00",
"value" : 500000
} ]
},
"T!T" : {
"aggregates" : [ {
"label" : "$2,554,564.00",
"value" : 2554564
} ]
},
91
Examples: Dashboards REST API Resources
Return Details About Dashboard Components
"0_3!T" : {
"aggregates" : [ {
"label" : "$440,000.00",
"value" : 440000
} ]
},
"1_4!T" : {
"aggregates" : [ {
"label" : "$13.00",
"value" : 13
} ]
},
"0_4!T" : {
"aggregates" : [ {
"label" : "$20,000.00",
"value" : 20000
} ]
},
"1_1!T" : {
"aggregates" : [ {
"label" : "$11.00",
"value" : 11
} ]
},
"0_5!T" : {
"aggregates" : [ {
"label" : "$90,000.00",
"value" : 90000
} ]
},
"1_2!T" : {
"aggregates" : [ {
"label" : "$40,000.00",
"value" : 40000
} ]
},
"0_6!T" : {
"aggregates" : [ {
"label" : "$43,320.00",
"value" : 43320
} ]
},
"0_7!T" : {
"aggregates" : [ {
"label" : "$138.00",
"value" : 138
} ]
},
"1_0!T" : {
"aggregates" : [ {
"label" : "$50,012.00",
"value" : 50012
} ]
},
92
Examples: Dashboards REST API Resources
Return Details About Dashboard Components
"2_2!T" : {
"aggregates" : [ {
"label" : "$100,017.00",
"value" : 100017
} ]
},
"2_3!T" : {
"aggregates" : [ {
"label" : "$20,018.00",
"value" : 20018
} ]
},
"2_4!T" : {
"aggregates" : [ {
"label" : "$0.00",
"value" : 0
} ]
},
"2_0!T" : {
"aggregates" : [ {
"label" : "$100,000.00",
"value" : 100000
} ]
},
"2_1!T" : {
"aggregates" : [ {
"label" : "$1,110,000.00",
"value" : 1110000
} ]
}
},
"groupingsAcross" : null,
"groupingsDown" : {
"groupings" : [ {
"groupings" : [ {
"groupings" : [ ],
"key" : "0_0",
"label" : "March 2013",
"value" : "2013-03-01"
}, {
"groupings" : [ ],
"key" : "0_1",
"label" : "July 2015",
"value" : "2015-07-01"
}, {
"groupings" : [ ],
"key" : "0_2",
"label" : "August 2015",
"value" : "2015-08-01"
}, {
"groupings" : [ ],
"key" : "0_3",
"label" : "September 2015",
"value" : "2015-09-01"
93
Examples: Dashboards REST API Resources
Return Details About Dashboard Components
}, {
"groupings" : [ ],
"key" : "0_4",
"label" : "October 2015",
"value" : "2015-10-01"
}, {
"groupings" : [ ],
"key" : "0_5",
"label" : "November 2015",
"value" : "2015-11-01"
}, {
"groupings" : [ ],
"key" : "0_6",
"label" : "December 2015",
"value" : "2015-12-01"
}, {
"groupings" : [ ],
"key" : "0_7",
"label" : "March 2016",
"value" : "2016-03-01"
} ],
"key" : "0",
"label" : "Manufacturing",
"value" : "Manufacturing"
}, {
"groupings" : [ {
"groupings" : [ ],
"key" : "1_0",
"label" : "February 2013",
"value" : "2013-02-01"
}, {
"groupings" : [ ],
"key" : "1_1",
"label" : "February 2015",
"value" : "2015-02-01"
}, {
"groupings" : [ ],
"key" : "1_2",
"label" : "September 2015",
"value" : "2015-09-01"
}, {
"groupings" : [ ],
"key" : "1_3",
"label" : "February 2016",
"value" : "2016-02-01"
}, {
"groupings" : [ ],
"key" : "1_4",
"label" : "April 2016",
"value" : "2016-04-01"
} ],
"key" : "1",
"label" : "Media",
"value" : "Media"
94
Examples: Dashboards REST API Resources
Return Details About Dashboard Components
}, {
"groupings" : [ {
"groupings" : [ ],
"key" : "2_0",
"label" : "November 2015",
"value" : "2015-11-01"
}, {
"groupings" : [ ],
"key" : "2_1",
"label" : "December 2015",
"value" : "2015-12-01"
}, {
"groupings" : [ ],
"key" : "2_2",
"label" : "March 2016",
"value" : "2016-03-01"
}, {
"groupings" : [ ],
"key" : "2_3",
"label" : "May 2016",
"value" : "2016-05-01"
}, {
"groupings" : [ ],
"key" : "2_4",
"label" : "June 2016",
"value" : "2016-06-01"
} ],
"key" : "2",
"label" : "Technology",
"value" : "Technology"
} ]
},
"hasDetailRows" : false,
"reportExtendedMetadata" : {
"aggregateColumnInfo" : {
"s!AMOUNT" : {
"dataType" : "currency",
"label" : "Sum of Amount"
}
},
"detailColumnInfo" : { },
"groupingColumnInfo" : {
"INDUSTRY" : {
"dataType" : "picklist",
"groupingLevel" : 0,
"label" : "Industry"
},
"CLOSE_DATE" : {
"dataType" : "date",
"groupingLevel" : 0,
"label" : "Close Date"
}
}
},
95
Examples: Dashboards REST API Resources
Return Details About Dashboard Components
"reportMetadata" : {
"aggregates" : [ "s!AMOUNT" ],
"buckets" : [ {
"bucketType" : "picklist",
"devloperName" : "BucketField_47575792",
"label" : "Industry",
"nullTreatedAsZero" : false,
"otherBucketLabel" : null,
"sourceColumnName" : "INDUSTRY",
"values" : [ {
"label" : "Technology",
"rangeUpperBound" : null,
"sourceDimensionValues" : [ "Agriculture", "Apparel", "Banking",
"Biotechnology", "Chemicals", "Communications", "Construction", "Consulting", "Education",
"Electronics" ]
}, {
"label" : "Energy",
"rangeUpperBound" : null,
"sourceDimensionValues" : [ "Energy", "Engineering", "Entertainment",
"Environmental", "Finance", "Food & Beverage", "Government", "Healthcare", "Hospitality",
"Insurance", "Machinery", "Manufacturing" ]
}, {
"label" : "Healthcare",
"rangeUpperBound" : null,
"sourceDimensionValues" : [ "Media", "Not For Profit", "Other", "Recreation",
"Retail", "Shipping", "Technology", "Telecommunications", "Transportation", "Utilities"
]
} ]
}, {
"bucketType" : "picklist",
"devloperName" : "BucketField_36625466",
"label" : "Stage",
"nullTreatedAsZero" : false,
"otherBucketLabel" : null,
"sourceColumnName" : "STAGE_NAME",
"values" : [ {
"label" : "Early",
"rangeUpperBound" : null,
"sourceDimensionValues" : [ "Prospecting", "Qualification", "Needs Analysis"
]
}, {
"label" : "Late",
"rangeUpperBound" : null,
"sourceDimensionValues" : [ "Value Proposition", "Id. Decision Makers",
"Perception Analysis", "Proposal/Price Quote", "Negotiation/Review" ]
}, {
"label" : "Won",
"rangeUpperBound" : null,
"sourceDimensionValues" : [ "Closed Won" ]
}, {
"label" : "Lost",
"rangeUpperBound" : null,
"sourceDimensionValues" : [ "Closed Lost" ]
} ]
96
Examples: Dashboards REST API Resources
Return Details About Dashboard Components
} ],
"chart" : null,
"crossFilters" : [ ],
"currency" : null,
"description" : null,
"detailColumns" : [ ],
"developerName" : "Pipeline_By_Industry1",
"division" : null,
"folderId" : "005R0000000Hv5rIAC",
"groupingsAcross" : [ ],
"groupingsDown" : [ {
"dateGranularity" : "None",
"name" : "INDUSTRY",
"sortAggregate" : null,
"sortOrder" : "Asc"
}, {
"dateGranularity" : "Month",
"name" : "CLOSE_DATE",
"sortAggregate" : null,
"sortOrder" : "Asc"
} ],
"hasDetailRows" : true,
"hasRecordCount" : false,
"historicalSnapshotDates" : [ ],
"id" : "00OR0000000OgsOMAS",
"name" : "Copy of Pipeline By Industry",
"reportBooleanFilter" : null,
"reportFilters" : [ {
"column" : "ACCOUNT_TYPE",
"isRunPageEditable" : false,
"operator" : "lessOrEqual",
"value" : "Integrator,Partner,Prospect"
}, {
"column" : "INDUSTRY",
"isRunPageEditable" : true,
"operator" : "notEqual",
"value" : ""
} ],
"reportFormat" : "SUMMARY",
"reportType" : {
"label" : "Opportunities",
"type" : "Opportunity"
},
"scope" : "organization",
"showGrandTotal" : true,
"showSubtotals" : true,
"sortBy" : [ ],
"standardDateFilter" : {
"column" : "CLOSE_DATE",
"durationValue" : "CUSTOM",
"endDate" : null,
"startDate" : null
},
"standardFilters" : [ {
97
Examples: Dashboards REST API Resources
Return Details About Dashboard Components
"name" : "open",
"value" : "all"
}, {
"name" : "probability",
"value" : ">0"
} ]
}
},
"status" : {
"dataStatus" : "DATA",
"errorCode" : null,
"errorMessage" : null,
"errorSeverity" : null,
"refreshDate" : "2016-03-22T18:24:39.000+0000",
"refreshStatus" : "IDLE"
}
} ],
"dashboardMetadata" : {
"canChangeRunningUser" : false,
"components" : [ {
"componentData" : 0,
"footer" : null,
"header" : "Pipeline This Quarter",
"id" : "01aR00000005aT4IAI",
"properties" : {
"aggregates" : [ {
"name" : "s!AMOUNT"
} ],
"autoSelectColumns" : false,
"filterColumns" : [ ],
"groupings" : null,
"maxRows" : null,
"sort" : null,
"useReportChart" : false,
"visualizationProperties" : {
"breakPoints" : [ {
"aggregateName" : "s!AMOUNT",
"breaks" : [ {
"color" : "c23934",
"lowerBound" : 0,
"upperBound" : 200000
}, {
"color" : "ffb75d",
"lowerBound" : 200000,
"upperBound" : 400000
}, {
"color" : "00716b",
"lowerBound" : 400000,
"upperBound" : 600000
} ]
} ],
"showPercentages" : true,
"showTotal" : true
},
98
Examples: Dashboards REST API Resources
Return Details About Dashboard Components
"visualizationType" : "Gauge"
},
"reportId" : "00OR0000000K2UeMAK",
"title" : null,
"type" : "Report"
}, {
"componentData" : 1,
"footer" : null,
"header" : "Pipeline by Industry",
"id" : "01aR00000005aT5IAI",
"properties" : {
"aggregates" : [ {
"name" : "s!AMOUNT"
} ],
"autoSelectColumns" : false,
"filterColumns" : [ ],
"groupings" : [ {
"name" : "INDUSTRY"
} ],
"maxRows" : null,
"sort" : {
"column" : "INDUSTRY",
"sortOrder" : "asc"
},
"useReportChart" : false,
"visualizationProperties" : {
"combineSmallGroups" : false,
"legendPosition" : "Bottom",
"showPercentages" : false,
"showTotal" : false,
"showValues" : false
},
"visualizationType" : "Donut"
},
"reportId" : "00OR0000000OgsOMAS",
"title" : null,
"type" : "Report"
} ],
"description" : null,
"developerName" : "yTtOilrkFGewFKpFUOscDuukUApfxH",
"filters" : [ ],
"folderId" : "00lR0000000DnRZIA0",
"id" : "01ZR00000008h2EMAQ",
"layout" : {
"components" : [ {
"colspan" : 3,
"column" : 0,
"row" : 0,
"rowspan" : 4
}, {
"colspan" : 3,
"column" : 0,
"row" : 4,
"rowspan" : 4
99
Examples: Dashboards REST API Resources
Get Dashboard Metadata
} ],
"gridLayout" : true,
"numColumns" : 9,
"rowHeight" : 80
},
"name" : "Liz's Sales Manager Dashboard",
"runningUser" : {
"displayName" : "Vandelay Art",
"id" : "005R0000000Hv5rIAC"
}
}
}
Get Dashboard Metadata
Get details about dashboard metadata using a GET request.
Use a GET request on the Dashboard Describe resource to get metadata for the specified dashboard, including dashboard components,
filters, layout, and the running user.
Example Usage
/services/data/v37.0/analytics/dashboards/01ZR00000004SknMAE/describe
Example Response Body
{
"canChangeRunningUser" : true,
"components" : [ {
"componentData" : 0,
"footer" : null,
"header" : null,
"id" : "01aR00000005kCmIAI",
"properties" : {
"aggregates" : [ {
"name" : "s!AMOUNT"
} ],
"autoSelectColumns" : true,
"filterColumns" : [ {
"label" : "Closed",
"name" : "CLOSED"
}, {
"label" : "Account Type",
"name" : "ACCOUNT_TYPE"
}, {
"label" : "Annual Revenue",
"name" : "SALES"
} ],
"groupings" : [ {
"name" : "STAGE_NAME"
} ],
"maxRows" : null,
"sort" : {
"column" : "STAGE_NAME",
100
Examples: Dashboards REST API Resources
Get Dashboard Metadata
"sortOrder" : "asc"
},
"useReportChart" : false,
"visualizationProperties" : {
"axisRange" : {
"max" : null,
"min" : null,
"rangeType" : "auto"
},
"groupByType" : "cumulative",
"legendPosition" : "Bottom",
"showValues" : false
},
"visualizationType" : "Line"
},
"reportId" : "00OR0000000JizXMAS",
"title" : null,
"type" : "Report"
}, {
"componentData" : 1,
"footer" : null,
"header" : null,
"id" : "01aR00000005awVIAQ",
"properties" : {
"aggregates" : [ {
"name" : "s!AMOUNT"
} ],
"autoSelectColumns" : true,
"filterColumns" : [ {
"label" : "Closed",
"name" : "CLOSED"
}, {
"label" : "Account Type",
"name" : "ACCOUNT_TYPE"
}, {
"label" : "Annual Revenue",
"name" : "SALES"
} ],
"groupings" : [ {
"name" : "STAGE_NAME"
} ],
"maxRows" : null,
"sort" : {
"column" : "STAGE_NAME",
"sortOrder" : "asc"
},
"useReportChart" : false,
"visualizationProperties" : {
"combineSmallGroups" : true,
"legendPosition" : "Bottom",
"showPercentages" : false,
"showValues" : true
},
"visualizationType" : "Funnel"
101
Examples: Dashboards REST API Resources
Get Dashboard Metadata
},
"reportId" : "00OR0000000OFXeMAO",
"title" : null,
"type" : "Report"
}, {
"componentData" : 2,
"footer" : null,
"header" : null,
"id" : "01aR00000005awTIAQ",
"properties" : {
"aggregates" : [ {
"name" : "s!AMOUNT"
} ],
"autoSelectColumns" : true,
"filterColumns" : [ {
"label" : "Closed",
"name" : "CLOSED"
}, {
"label" : "Account Type",
"name" : "ACCOUNT_TYPE"
}, {
"label" : "Annual Revenue",
"name" : "SALES"
} ],
"groupings" : null,
"maxRows" : null,
"sort" : null,
"useReportChart" : false,
"visualizationProperties" : {
"breakPoints" : [ {
"aggregateName" : "s!AMOUNT",
"breaks" : [ {
"color" : "c25454",
"lowerBound" : 100000,
"upperBound" : 300000
}, {
"color" : "c2c254",
"lowerBound" : 300000,
"upperBound" : 800000
}, {
"color" : "54c254",
"lowerBound" : 800000,
"upperBound" : 1000000
} ]
} ],
"showPercentages" : false,
"showTotal" : false
},
"visualizationType" : "Gauge"
},
"reportId" : "00OR0000000JizXMAS",
"title" : null,
"type" : "Report"
}, {
102
Examples: Dashboards REST API Resources
Get Dashboard Metadata
"componentData" : 3,
"footer" : null,
"header" : null,
"id" : "01aR00000005kCnIAI",
"properties" : {
"aggregates" : [ {
"name" : "s!AMOUNT"
}, {
"name" : "a!AMOUNT"
} ],
"autoSelectColumns" : false,
"filterColumns" : [ {
"label" : "Closed",
"name" : "CLOSED"
}, {
"label" : "Account Type",
"name" : "ACCOUNT_TYPE"
}, {
"label" : "Annual Revenue",
"name" : "SALES"
} ],
"groupings" : [ {
"name" : "STAGE_NAME"
}, {
"name" : "TYPE"
} ],
"maxRows" : null,
"sort" : {
"column" : "STAGE_NAME",
"sortOrder" : "asc"
},
"useReportChart" : false,
"visualizationProperties" : {
"axisRange" : {
"max" : null,
"min" : null,
"rangeType" : "auto"
},
"groupByType" : "grouped",
"legendPosition" : "Bottom"
},
"visualizationType" : "Scatter"
},
"reportId" : "00OR0000000JizXMAS",
"title" : null,
"type" : "Report"
}, {
"componentData" : 4,
"footer" : null,
"header" : "My Table",
"id" : "01aR00000005awUIAQ",
"properties" : {
"aggregates" : [ {
"name" : "s!AMOUNT"
103
Examples: Dashboards REST API Resources
Get Dashboard Metadata
} ],
"autoSelectColumns" : false,
"filterColumns" : [ {
"label" : "Closed",
"name" : "CLOSED"
}, {
"label" : "Account Type",
"name" : "ACCOUNT_TYPE"
}, {
"label" : "Annual Revenue",
"name" : "SALES"
} ],
"groupings" : [ {
"name" : "INDUSTRY"
}, {
"name" : "CLOSE_DATE"
} ],
"maxRows" : null,
"sort" : {
"column" : "INDUSTRY",
"sortOrder" : "asc"
},
"useReportChart" : false,
"visualizationProperties" : {
"breakPoints" : [ {
"aggregateName" : "s!AMOUNT",
"breaks" : [ {
"color" : "c25454",
"lowerBound" : null,
"upperBound" : null
}, {
"color" : "c2c254",
"lowerBound" : null,
"upperBound" : null
}, {
"color" : "54c254",
"lowerBound" : null,
"upperBound" : null
} ]
} ],
"tableColumns" : [ {
"column" : "INDUSTRY",
"isPercent" : false,
"scale" : null,
"showTotal" : false,
"type" : "grouping"
}, {
"column" : "CLOSE_DATE",
"isPercent" : false,
"scale" : null,
"showTotal" : false,
"type" : "grouping"
}, {
"column" : "s!AMOUNT",
104
Examples: Dashboards REST API Resources
Get Dashboard Metadata
"isPercent" : false,
"scale" : null,
"showTotal" : true,
"type" : "aggregate"
} ]
},
"visualizationType" : "Table"
},
"reportId" : "00OR0000000OgsOMAS",
"title" : "My Table",
"type" : "Report"
}, {
"componentData" : 5,
"footer" : null,
"header" : null,
"id" : "01aR00000005kCoIAI",
"properties" : {
"aggregates" : [ {
"name" : "s!AMOUNT"
} ],
"autoSelectColumns" : false,
"filterColumns" : [ {
"label" : "Closed",
"name" : "CLOSED"
}, {
"label" : "Account Type",
"name" : "ACCOUNT_TYPE"
}, {
"label" : "Annual Revenue",
"name" : "SALES"
} ],
"groupings" : [ {
"name" : "STAGE_NAME"
}, {
"name" : "TYPE"
} ],
"maxRows" : null,
"sort" : {
"column" : "STAGE_NAME",
"sortOrder" : "asc"
},
"useReportChart" : false,
"visualizationProperties" : {
"aggregateVisualizationInfos" : [ {
"axis" : "Y2",
"visualizationType" : "Column"
} ],
"axisRange" : {
"max" : null,
"min" : null,
"rangeType" : "auto"
},
"groupByType" : "grouped",
"legendPosition" : "Bottom",
105
Examples: Dashboards REST API Resources
Get Dashboard Metadata
"showValues" : false
},
"visualizationType" : "Column"
},
"reportId" : "00OR0000000JizXMAS",
"title" : null,
"type" : "Report"
}, {
"componentData" : 6,
"footer" : null,
"header" : null,
"id" : "01aR00000005kCpIAI",
"properties" : {
"aggregates" : [ {
"name" : "s!AMOUNT"
}, {
"name" : "a!AMOUNT"
} ],
"autoSelectColumns" : false,
"filterColumns" : [ {
"label" : "Closed",
"name" : "CLOSED"
}, {
"label" : "Account Type",
"name" : "ACCOUNT_TYPE"
}, {
"label" : "Annual Revenue",
"name" : "SALES"
} ],
"groupings" : [ {
"name" : "STAGE_NAME"
} ],
"maxRows" : null,
"sort" : {
"column" : "STAGE_NAME",
"sortOrder" : "asc"
},
"useReportChart" : false,
"visualizationProperties" : {
"axisRange" : {
"max" : null,
"min" : null,
"rangeType" : "auto"
},
"groupByType" : "none",
"legendPosition" : "Bottom",
"showValues" : false
},
"visualizationType" : "Bar"
},
"reportId" : "00OR0000000JizXMAS",
"title" : null,
"type" : "Report"
} ],
106
Examples: Dashboards REST API Resources
Get Dashboard Metadata
"description" : null,
"developerName" : "Filtered_Dashboard",
"filters" : [ {
"errorMessage" : null,
"id" : "0IBR00000004CElOAM",
"name" : "Closed",
"options" : [ {
"alias" : "Open",
"endValue" : null,
"id" : "0ICR00000004CG4OAM",
"operation" : "equals",
"startValue" : null,
"value" : "True"
}, {
"alias" : "Closed",
"endValue" : null,
"id" : "0ICR00000004CG5OAM",
"operation" : "equals",
"startValue" : null,
"value" : "False"
} ],
"selectedOption" : null
}, {
"errorMessage" : null,
"id" : "0IBR00000004CEmOAM",
"name" : "Account Type",
"options" : [ {
"alias" : null,
"endValue" : null,
"id" : "0ICR00000004CG6OAM",
"operation" : "equals",
"startValue" : null,
"value" : "Analyst"
}, {
"alias" : null,
"endValue" : null,
"id" : "0ICR00000004CG7OAM",
"operation" : "equals",
"startValue" : null,
"value" : "Competitor"
}, {
"alias" : null,
"endValue" : null,
"id" : "0ICR00000004CG8OAM",
"operation" : "equals",
"startValue" : null,
"value" : "Press,Prospect,Reseller"
}, {
"alias" : null,
"endValue" : null,
"id" : "0ICR00000004CG9OAM",
"operation" : "notEqual",
"startValue" : null,
"value" : "Other"
107
Examples: Dashboards REST API Resources
Clone a Dashboard
}, {
"alias" : "Outsiders",
"endValue" : null,
"id" : "0ICR00000004CGAOA2",
"operation" : "lessOrEqual",
"startValue" : null,
"value" : "Integrator,Partner,Prospect"
} ],
"selectedOption" : null
}, {
"errorMessage" : null,
"id" : "0IBR0000000007cOAA",
"name" : "Annual Revenue",
"options" : [ {
"alias" : null,
"endValue" : null,
"id" : "0ICR000000000A5OAI",
"operation" : "lessThan",
"startValue" : null,
"value" : "\"400,000\""
} ],
"selectedOption" : null
} ],
"folderId" : "00lR0000000DnRZIA0",
"id" : "01ZR00000004SknMAE",
"layout" : {
"columns" : [ {
"components" : [ 0, 1, 2 ]
}, {
"components" : [ 3, 4 ]
}, {
"components" : [ 5, 6 ]
} ],
"gridLayout" : false
},
"name" : "Filtered Dashboard",
"runningUser" : {
"displayName" : "Vandelay Art",
"id" : "005R0000000Hv5rIAC"
}
}
Clone a Dashboard
Creates a copy of a dashboard by sending a POST request to the Dashboard List resource.
Example
You want to clone dashboard 01ZR00000008gkvMAA and save it in a new folder with ID 00lR0000000DnRZIA0.
108
Examples: Dashboards REST API Resources
Delete a Dashboard
This POST request /services/data/v35.0/analytics/dashboards/?cloneId=01ZR00000008gkvMAA to the
Dashboard List resource clones the dashboard.
{"folderId":"00lR0000000DnRZIA0"}
The response to the POST request returns the following details about the cloned dashboard.
{ "attributes" :
{ "dashboardId" : "01ZR00000004SZZMA2",
"dashboardName" : "Sales Manager Dashboard",
"statusUrl" : "/services/data/v35.0/analytics/dashboards/01ZR00000004SZZMA2/status",
"type" : "Dashboard" },
...
"folderId" : "00lR0000000DnRZIA0",
"id" : "01ZR00000004SZZMA2",
"layout" : {
"columns" : [
{ "components" : [ 0, 1, 2, 3 ] },
{ "components" : [ 4, 5, 6 ] },
{ "components" : [ 7 ] } ],
"gridLayout" : false },
"name" : "Sales Manager Dashboard",
"runningUser" : { "displayName" : "Fred Wiliamson", "id" : "005R0000000Hv5rIAC" }
}
Delete a Dashboard
Delete a dashboard by sending a DELETE request to the Dashboard Results resource. Deleted dashboards are moved to the Recycle Bin.
Example
This DELETE request /services/data/v34.0/analytics/dashboards/01ZD00000007S89MAE to the Dashboard
Results resource deletes the dashboard and returns a 204 HTTP response code with no content in the response body.
109
CHAPTER 4
In this chapter ...
•
Get Analytics
Notifications
•
Create an Analytics
Notification
•
Save Changes to an
Analytics Notification
•
Delete an Analytics
Notification
•
Check Limits for
Analytics
Notifications
Examples: Analytics Notifications REST API
Use the Analytics Notifications REST API to get, update, create, and delete notifications about reports
and Wave assets.
110
Examples: Analytics Notifications REST API
Get Analytics Notifications
Get Analytics Notifications
Return a list of analytics notifications using a GET request.
Use a GET request on the Analytics Notification List resource to return a list of analytics notifications.
Example Usage
/services/data/v38.0/analytics/notifications?source=lightningSubscribe
Parameter Description
source
Required for GET calls. Specifies what type of analytics notification to return. Valid values are:
• lightningSubscribe — report subscriptions
• waveNotification — Wave notifications
recordId
Optional. Return notifications for a single record. Valid values are:
• reportId— Unique report ID
• lensId— Unique Wave lens ID
Example Response Body
[ {
"active" : true,
"createdDate" : "2016-08-08T04:14:12Z",
"deactivateOnTrigger" : false,
"id" : "0AuR00000004CYpKAM",
"lastModifiedDate" : "2016-08-08T04:14:12Z",
"name" : "Notification1",
"recordId" : "00OR0000000P7EgMAK",
"schedule" : {
"details" : {
"time" : 3
},
"frequency" : "daily"
},
"source" : "lightningSubscribe",
"thresholds" : [ {
"actions" : [ {
"configuration" : {
"recipients" : [ ]
},
"type" : "sendEmail"
} ],
"conditions" : null,
"type" : "always"
} ]
}, {
"active" : true,
"createdDate" : "2016-08-10T22:22:17Z",
"deactivateOnTrigger" : false,
"id" : "0AuR000000000KSKAY",
111
Examples: Analytics Notifications REST API
Get Analytics Notifications
"lastModifiedDate" : "2016-08-11T23:16:01Z",
"name" : "Notification2",
"recordId" : "00OR0000000PCHYMA4",
"schedule" : {
"details" : {
"daysOfMonth" : [ 1, 2, 4 ],
"time" : 22
},
"frequency" : "monthly",
"frequencyType" : "specific"
},
"source" : "lightningSubscribe",
"thresholds" : [ {
"actions" : [ {
"configuration" : {
"recipients" : [ ]
},
"type" : "sendEmail"
} ],
"conditions" : null,
"type" : "always"
} ]
}, {
"active" : true,
"createdDate" : "2016-08-12T04:01:50Z",
"deactivateOnTrigger" : false,
"id" : "0AuR000000000KcKAI",
"lastModifiedDate" : "2016-08-12T04:16:34Z",
"name" : "Notification3",
"recordId" : "00OR0000000PBXEMA4",
"schedule" : {
"details" : {
"dayInWeek" : "mon",
"time" : 22,
"weekInMonth" : "third"
},
"frequency" : "monthly",
"frequencyType" : "relative"
},
"source" : "lightningSubscribe",
"thresholds" : [ {
"actions" : [ {
"configuration" : {
"recipients" : [ ]
},
"type" : "sendEmail"
} ],
"conditions" : null,
"type" : "always"
} ]
} ]
112
Examples: Analytics Notifications REST API
Create an Analytics Notification
Create an Analytics Notification
Create an Analytics Notification using a POST request.
Use a POST request on the Analytics Notification List resource to create an analytics notification.
Example Usage
/services/data/v38.0/analytics/notifications
Example Request Body
{
"active" : true,
"createdDate" : "",
"deactivateOnTrigger" : false,
"id" : "",
"lastModifiedDate" : "",
"name" : "New Notification",
"recordId" : "00OR0000000PD55MAG",
"schedule" : {
"details" : {
"time" : 3
},
"frequency" : "daily"
},
"source" : "lightningSubscribe",
"thresholds" : [ {
"actions" : [ {
"configuration" : {
"recipients" : [ ]
},
"type" : "sendEmail"
} ],
"conditions" : null,
"type" : "always"
} ]
}
Example Response Body
{
"active" : true,
"createdDate" : "2016-08-12T05:57:19Z",
"deactivateOnTrigger" : false,
"id" : "0AuR00000004CZTKA2",
"lastModifiedDate" : "2016-08-12T05:57:19Z",
"name" : "New Notification",
"recordId" : "00OR0000000PD55MAG",
"schedule" : {
"details" : {
"time" : 3
},
"frequency" : "daily"
},
"source" : "lightningSubscribe",
"thresholds" : [ {
113
Examples: Analytics Notifications REST API
Save Changes to an Analytics Notification
"actions" : [ {
"configuration" : {
"recipients" : [ ]
},
"type" : "sendEmail"
} ],
"conditions" : null,
"type" : "always"
} ]
}
Save Changes to an Analytics Notification
Save Changes to an Analytics Notification using a PUT request.
Use a PUT request on the Analytics Notification resource to save changes to an analytics notification.
Example Usage
/services/data/v38.0/analytics/notifications/analytics notification ID
Example Request Body
In this example, an analytics notification is changed so that it runs daily at 9:00 AM instead of 3:00 AM.
{
"active" : true,
"createdDate" : "",
"deactivateOnTrigger" : false,
"id" : "0AuR00000004CZTKA2",
"lastModifiedDate" : "",
"name" : "New Notification",
"recordId" : "00OR0000000PD55MAG",
"schedule" : {
"details" : {
"time" : 9
},
"frequency" : "daily"
},
"source" : "lightningSubscribe",
"thresholds" : [ {
"actions" : [ {
"configuration" : {
"recipients" : [ ]
},
"type" : "sendEmail"
} ],
"conditions" : null,
"type" : "always"
} ]
}
114
Examples: Analytics Notifications REST API
Delete an Analytics Notification
Example Response Body
The response body reflects the updated and saved analytics notifications.
{
"active" : true,
"createdDate" : "2016-08-12T05:57:19Z",
"deactivateOnTrigger" : false,
"id" : "0AuR00000004CZTKA2",
"lastModifiedDate" : "2016-08-12T06:12:24Z",
"name" : "New Notification",
"recordId" : "00OR0000000PD55MAG",
"schedule" : {
"details" : {
"time" : 9
},
"frequency" : "daily"
},
"source" : "lightningSubscribe",
"thresholds" : [ {
"actions" : [ {
"configuration" : {
"recipients" : [ ]
},
"type" : "sendEmail"
} ],
"conditions" : null,
"type" : "always"
} ]
}
Delete an Analytics Notification
Delete an Analytics Notification using a DELETE request. Once deleted, the analytics notification can't be recovered.
Use a DELETE request on the Analytics Notification resource to delete an analytics notification.
Example Usage
/services/data/v38.0/analytics/notifications/analytics notification ID
The analytic notification deletes and returns a 204 HTTP response code with no content in the response body.
Check Limits for Analytics Notifications
Check analytics notification limits using a GET request.
Use a GET request on the Analytics Notification Limits resource to check limits for analytics notifications.
Example Usage
/services/data/v38.0/analytics/notifications/limits?source=waveNotification
Method
Description
GET
Check how many analytic notifications you have, and the maximum number you can have.
115
Examples: Analytics Notifications REST API
Check Limits for Analytics Notifications
Example Response Body
{
"userLimit" : {
"max" : 5,
"remaining" : 2
}
}
116
CHAPTER 5
In this chapter ...
•
Report
•
Describe
•
Execute Sync
•
Execute Async
•
Instances List
•
Instance Results
•
Report List
•
Query
•
Report Error Codes
Reports API Resource Reference
Resources for the Reports API are available at /services/data//analytics/reports. You can query each resource with a HTTP method (such as
GET). Use these resources to integrate report data directly into your applications.
Resource
Supported Description
HTTP
Method
Report
PATCH
Saves changes to a report.
DELETE
Deletes a report.
Describe
GET
Gives report metadata. This includes information about fields that
are defined in the report as detail columns, summaries, custom
summary formulas, filters, and groupings.
Execute Sync
GET
Gives report summary level data with or without details.
POST
Returns specific results if you define dynamic filters, groupings, or
aggregates in the metadata of a POST request.
Execute Async
POST
Returns an instance that stores summary level data with or without
details for a report run asynchronously. To get specific results,
define filters in the metadata of the request.
Instances List
GET
List of instances of a report that were requested for an
asynchronous run.
Instance Results
GET
Depending on the type of your request, gives summary level data
with or without details for an instance of a report run
asynchronously.
Report List
GET
List of reports that were recently viewed by the API user.
POST
Makes a copy of a report.
117
Reports API Resource Reference
Report
Report
Saves changes to a report or deletes a report.
Resource URL
Data
Summary
URL
/services/data//analytics/reports/
Formats
JSON
HTTP Methods
Method
Description
PATCH
Saves changes to a report. See this example.
DELETE
Deletes a report. See this example.
PATCH Request Body
Property
Type
Description
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! 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.
buckets
Bucket field
Describes a bucket field.
chart
Chart[]
Details about the chart used in a report.
crossFilters
Cross filter on page
137[]
Cross filters applied to the report.
118
Reports API Resource Reference
Report
Property
Type
Description
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.
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.
Note: When the report is in the My Personal Custom Reports
folder, folderId = userId. When the report is in the Unfiled Public
Reports folder, folderId = orgId.
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.
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.
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.
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
119
Reports API Resource Reference
Property
Report
Type
Description
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"
}
]
}
}
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. Value can be:
• TABULAR
• SUMMARY
• MATRIX
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.
120
Reports API Resource Reference
Report
Property
Type
Description
sortBy
Array of strings
API name of the field on which the report is sorted and the direction
of the sort (asc or desc).
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.
PATCH Response Body
Property
Type
Description
reportMetadata
Report metadata
Unique identifiers for groupings and summaries.
reportTypeMetadata
Report type metadata
Fields in each section of a report type plus filter information for those
fields.
reportExtendedMetadata Report extended
Additional information about summaries and groupings.
metadata
Report metadata
Property
Type
Description
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.
121
Reports API Resource Reference
Property
Report
Type
Description
• 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! 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.
buckets
Bucket field
Describes a bucket field.
chart
Chart[]
Details about the chart used in a report.
crossFilters
Cross filter on page
128[]
Cross filters applied to the report.
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.
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.
Note: When the report is in the My Personal Custom Reports
folder, folderId = userId. When the report is in the Unfiled
Public Reports folder, folderId = orgId.
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.
122
Reports API Resource Reference
Report
Property
Type
Description
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.
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.
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.”
{
...
"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"
}
]
}
}
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. Value can be:
• TABULAR
123
Reports API Resource Reference
Property
Report
Type
Description
• SUMMARY
• MATRIX
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).
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.
124
Reports API Resource Reference
Report
Chart
Property
Type
Description
chartType
String
Type of chart.
groupings
String
Report grouping.
hasLegend
Boolean
Indicates whether the report has a legend.
showChartValues
Boolean
Indicates whether the report shows chart values.
summaries
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! 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.
summaryAxisLocations
String
Specifies the axis that shows the summary values. Valid values are
X and Y.
title
String
Name of the chart.
Property
Type
Description
name
String
API name of the field used as a row grouping.
sortOrder
String
Order in which data is sorted within a row grouping. Value can be:
Groupings down
• Asc for ascending order.
• Desc for descending order.
dateGranularity
String
Interval set on a date field that’s used as a row grouping. Value can
be:
• Day
• Calendar Week
• Calendar Month
• Calendar Quarter
• Calendar Year
• Fiscal Quarter
• Fiscal Year
125
Reports API Resource Reference
Property
Report
Type
Description
• Calendar Month in Year
• Calendar Day in Month
sortAggregate
String
Summary field that’s used to sort data within a grouping in a report
that’s in summary format. Applies if you have the Aggregate Sort
feature enabled as part of its pilot program. The value is null when
data within a grouping is not sorted by a summary field. In this
example, data grouped by Account Owner is sorted by the sum of
Annual Revenue.
{
"aggregates": ["s!SALES","RowCount"],
"groupingsDown": [
{
"name": "USERS.NAME",
"sortOrder": "Desc",
"dateGranularity": "None",
"sortAggregate": "s!SALES"
}
]
}
Groupings across
Property
Type
Description
name
String
API name of the field used as a column grouping.
sortOrder
String
Order in which data is sorted within a column grouping. Value can
be:
• Asc for ascending order.
• Desc for descending order.
dateGranularity
String
Interval set on a date field used as a column grouping. Value can
be:
• Day
• Calendar Week
• Calendar Month
• Calendar Quarter
• Calendar Year
• Fiscal Quarter
• Fiscal Year
• Calendar Month in Year
• Calendar Day in Month
126
Reports API Resource Reference
Report
Filter details
Property
Type
Description
column
String
Unique API name for the field that’s being filtered.
isRunPageEditable
Boolean
Indicates if this is an editable filter in the user interface.
operator
String
Unique API name for the condition used to filter a field such as
“greater than” or “not equal to.” Filter conditions depend on the
data type of the field. Valid values are:
• equals
• notEqual
• lessThan
• greaterThan
• lessOrEqual
• greaterOrEqual
• contains
• notContain
• startsWith
• includes
• excludes
• within (DISTANCE criteria only)
value
String
Value by which a field is filtered. For example, the field Age can
be filtered by a numeric value.
For datetime fields, if you make a POST request and specify a
calendar date without including a time, then a default time gets
included. The time defaults to midnight minus the difference
between your timezone and Greenwich Mean Time (GMT). For
example, if you specify 8/8/2015 and your timezone is Pacific
Standard Time (GMT-700), then the API returns
2015-08-08T07:00:00Z.
Bucket field
Property
Type
Description
bucketType
BucketType
The type of bucket. Possible values are number, percent, and
picklist
developerName
String
API name of the bucket.
label
String
User-facing name of the bucket.
nullTreatedAsZero
Boolean
Specifies whether null values are converted to zero (true) or not
(false).
127
Reports API Resource Reference
Report
Property
Type
Description
otherBucketLabel
String
Name of the fields grouped as “Other” (in buckets of BucketType
PICKLIST).
sourceColumnName
String
Name of the bucketed field.
values
Array of
BucketTypeValues
Describes the values included in the bucket field..
Property
Type
Description
label
String
The user-facing name of the bucket.
sourceDimensionValues
String
A list of the values from the source field included in this bucket
category (in buckets of type PICKLIST and buckets of type TEXT).
rangeUpperBound
Double
The greatest range limit under which values are included in this
bucket category (in buckets of type NUMBER).
Property
Type
Description
criteria
Array of Filter details[] Information about how to filter the relatedEntity. Use to relate
the primary entity with a subset of the relatedEntity.
includesObject
Boolean
Specifies whether objects returned have a relationship with the
relatedEntity (true) or not (false).
primaryEntityField
String
The name of the object on which the cross filter is evaluated.
relatedEntity
String
The name of the object that the primaryEntityField is
evaluated against. (The right-hand side of the cross filter).
relatedEntityJoinField
String
The name of the field used to join the primaryEntityField
and relatedEntity.
Property
Type
Description
label
String
The user-facing name of the custom summary formula.
description
String
The user-facing description of the custom summary formula.
formulaType
String
The format of the numbers in the custom summary formula. Possible
values are number, currency, and percent.
decimalPlaces
Integer
The number of decimal places to include in numbers.
Bucket field value
Cross filter
Custom summary formula
128
Reports API Resource Reference
Describe
Property
Type
Description
downGroup
String
The name of a row grouping when the downGroupType is
CUSTOM. Null otherwise.
downGroupType
String
Where to display the aggregate of the custom summary formula.
Possible values are all, custom, and grand_total.
acrossGroup
String
The name of a column grouping when the accrossGroupType
is CUSTOM. Null otherwise.
acrossGroupType
String
Where to display the aggregate of the custom summary formula.
Possible values are all, custom, and grand_total.
formula
String
The operations performed on values in the custom summary formula.
Property
Type
Description
rowLimit
Integer
The number of rows returned in the report.
direction
String
The sort order of the report rows.
Top rows
Describe
Retrieves report, report type, and related metadata for a tabular, summary, or matrix report.
• Report metadata gives information about the report as a whole. Tells you such things as, the report type, format, the fields that are
summaries, row or column groupings, filters saved to the report, and so on.
• Report type metadata tells you about all the fields available in the report type, those you can filter, and by what filter criteria.
• Report extended metadata tells you about the fields that are summaries, groupings, and contain record details in the report. A
property that displays null indicates that its value is not available.
Resource URL
/services/data//analytics/reports//describe
Formats
JSON
HTTP Methods
Method
Description
GET
Retrieves report, report type, and related metadata for a tabular, summary, or matrix report. See this example.
129
Reports API Resource Reference
Describe
Response Body
Property
Type
Description
reportMetadata
Report metadata
Unique identifiers for groupings and summaries.
reportTypeMetadata
Report type metadata
Fields in each section of a report type plus filter information for those
fields.
reportExtendedMetadata Report extended
Additional information about summaries and groupings.
metadata
Report metadata
Property
Type
Description
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! 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.
buckets
Bucket field
Describes a bucket field.
chart
Chart[]
Details about the chart used in a report.
crossFilters
Cross filter on page
137[]
Cross filters applied to the report.
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.
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
130
Reports API Resource Reference
Property
Describe
Type
Description
have the “Affected by Divisions” permission, your reports include
records in all divisions.
folderId
String
ID of the folder that contains the report.
Note: When the report is in the My Personal Custom Reports
folder, folderId = userId. When the report is in the Unfiled
Public Reports folder, folderId = orgId.
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.
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.
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.
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.”
{
...
"reportBooleanFilter": "(1 OR 2) AND
3",
"reportFilters": [
{
"value":
"Analyst,Integrator,Press,Other",
"column": "TYPE",
"operator": "notEqual"
},
{
131
Reports API Resource Reference
Property
Describe
Type
Description
"value": "100,000",
"column": "SALES",
"operator": "greaterThan"
},
{
"value": "Small",
"column": "Size",
"operator": "notEqual"
}
]
}
}
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. Value can be:
• TABULAR
• SUMMARY
• MATRIX
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).
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.
132
Reports API Resource Reference
Describe
Property
Type
Description
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.
Chart
Property
Type
Description
chartType
String
Type of chart.
groupings
String
Report grouping.
hasLegend
Boolean
Indicates whether the report has a legend.
showChartValues
Boolean
Indicates whether the report shows chart values.
summaries
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! 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.
summaryAxisLocations
String
Specifies the axis that shows the summary values. Valid values are
X and Y.
title
String
Name of the chart.
133
Reports API Resource Reference
Describe
Groupings down
Property
Type
Description
name
String
API name of the field used as a row grouping.
sortOrder
String
Order in which data is sorted within a row grouping. Value can be:
• Asc for ascending order.
• Desc for descending order.
dateGranularity
String
Interval set on a date field that’s used as a row grouping. Value can
be:
• Day
• Calendar Week
• Calendar Month
• Calendar Quarter
• Calendar Year
• Fiscal Quarter
• Fiscal Year
• Calendar Month in Year
• Calendar Day in Month
sortAggregate
String
Summary field that’s used to sort data within a grouping in a report
that’s in summary format. Applies if you have the Aggregate Sort
feature enabled as part of its pilot program. The value is null when
data within a grouping is not sorted by a summary field. In this
example, data grouped by Account Owner is sorted by the sum of
Annual Revenue.
{
"aggregates": ["s!SALES","RowCount"],
"groupingsDown": [
{
"name": "USERS.NAME",
"sortOrder": "Desc",
"dateGranularity": "None",
"sortAggregate": "s!SALES"
}
]
}
Groupings across
Property
Type
Description
name
String
API name of the field used as a column grouping.
134
Reports API Resource Reference
Describe
Property
Type
Description
sortOrder
String
Order in which data is sorted within a column grouping. Value can
be:
• Asc for ascending order.
• Desc for descending order.
dateGranularity
String
Interval set on a date field used as a column grouping. Value can
be:
• Day
• Calendar Week
• Calendar Month
• Calendar Quarter
• Calendar Year
• Fiscal Quarter
• Fiscal Year
• Calendar Month in Year
• Calendar Day in Month
Filter details
Property
Type
Description
column
String
Unique API name for the field that’s being filtered.
isRunPageEditable
Boolean
Indicates if this is an editable filter in the user interface.
operator
String
Unique API name for the condition used to filter a field such as
“greater than” or “not equal to.” Filter conditions depend on the
data type of the field. Valid values are:
• equals
• notEqual
• lessThan
• greaterThan
• lessOrEqual
• greaterOrEqual
• contains
• notContain
• startsWith
• includes
• excludes
• within (DISTANCE criteria only)
135
Reports API Resource Reference
Describe
Property
Type
Description
value
String
Value by which a field is filtered. For example, the field Age can
be filtered by a numeric value.
For datetime fields, if you make a POST request and specify a
calendar date without including a time, then a default time gets
included. The time defaults to midnight minus the difference
between your timezone and Greenwich Mean Time (GMT). For
example, if you specify 8/8/2015 and your timezone is Pacific
Standard Time (GMT-700), then the API returns
2015-08-08T07:00:00Z.
Bucket field
Property
Type
Description
bucketType
BucketType
The type of bucket. Possible values are number, percent, and
picklist
developerName
String
API name of the bucket.
label
String
User-facing name of the bucket.
nullTreatedAsZero
Boolean
Specifies whether null values are converted to zero (true) or not
(false).
otherBucketLabel
String
Name of the fields grouped as “Other” (in buckets of BucketType
PICKLIST).
sourceColumnName
String
Name of the bucketed field.
values
Array of
BucketTypeValues
Describes the values included in the bucket field..
Property
Type
Description
label
String
The user-facing name of the bucket.
sourceDimensionValues
String
A list of the values from the source field included in this bucket
category (in buckets of type PICKLIST and buckets of type TEXT).
rangeUpperBound
Double
The greatest range limit under which values are included in this
bucket category (in buckets of type NUMBER).
Bucket field value
136
Reports API Resource Reference
Describe
Cross filter
Property
Type
Description
criteria
Array of Filter details[] Information about how to filter the relatedEntity. Use to relate
the primary entity with a subset of the relatedEntity.
includesObject
Boolean
Specifies whether objects returned have a relationship with the
relatedEntity (true) or not (false).
primaryEntityField
String
The name of the object on which the cross filter is evaluated.
relatedEntity
String
The name of the object that the primaryEntityField is
evaluated against. (The right-hand side of the cross filter).
relatedEntityJoinField
String
The name of the field used to join the primaryEntityField
and relatedEntity.
Property
Type
Description
label
String
The user-facing name of the custom summary formula.
description
String
The user-facing description of the custom summary formula.
formulaType
String
The format of the numbers in the custom summary formula. Possible
values are number, currency, and percent.
decimalPlaces
Integer
The number of decimal places to include in numbers.
downGroup
String
The name of a row grouping when the downGroupType is
CUSTOM. Null otherwise.
downGroupType
String
Where to display the aggregate of the custom summary formula.
Possible values are all, custom, and grand_total.
acrossGroup
String
The name of a column grouping when the accrossGroupType
is CUSTOM. Null otherwise.
acrossGroupType
String
Where to display the aggregate of the custom summary formula.
Possible values are all, custom, and grand_total.
formula
String
The operations performed on values in the custom summary formula.
Property
Type
Description
rowLimit
Integer
The number of rows returned in the report.
direction
String
The sort order of the report rows.
Custom summary formula
Top rows
137
Reports API Resource Reference
Describe
Report type metadata
Property
Type
Description
categories
Categories[]
All fields in the report type organized by section.
dataTypeFilterOperatorMap
Filter operator
reference
Lists all the possible field data types that can be used to filter
the report. Each data type, such as phone, percent, currency,
or picklist has two properties:
name: Of type string, this is a unique API name for each field
type’s filter criteria. Use this API name in the metadata to
define filter criteria for a report.
label: Of type string, this is the display name for each filter
criteria available to fields of a particular data type. For example,
multipicklist fields can have for filter criteria, “equals,”
“not equal to,” “includes,” and “excludes.” Bucket fields are
considered to be of string data type.
divisionInfo
Division info[]
Default division and list of all possible record-level divisions
that can be used in a report.
scopeInfo
Scope info[]
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.
standardDateFilterDurationGroups Standard date filter List of standard date filters available in reports.
duration groups[]
Array of strings
standardFilterInfos
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.
Categories
Property
Type
Description
label
String
Display name of a section in the report type under which fields are
organized. For example, in an Accounts with Contacts custom report
type, Account General is the display name of the section that
has fields on general account information.
columns
Column map
Information for all fields in the report type organized under a
particular section’s unique API name.
138
Reports API Resource Reference
Describe
Division info
Property
Type
Description
defaultValue
String
Users are assigned a default division that applies to their newly
created accounts, leads, and custom objects that are enabled for
divisions.
values
String
All division values. Division values have two properties:
label: Display name of a division.
name: Unique API name of a division.
Column map
Property
Type
Description
label
String
Display name of a field.
filterValues
String array
All filter values for a field, if the field data type is of picklist,
multi-select picklist, boolean, or checkbox. For example, checkbox
fields always have a value of True or False. For fields of other
data types, the filter value is an empty array because their values
can’t be determined. Filter values have two properties:
name: Unique API name for a filter value. Of type string.
label: Display name of a filter value. Of type string.
dataType
String
Data type of the field.
filterable
Boolean
False means that the field is of a type that can’t be filtered. For
example, fields of the type Encrypted Text can’t be filtered.
Property
Type
Description
defaultValue
String
Default scope of the data on which you run the report.
values
Array of strings
All scope values. Valid values depend on the report type. Scope
values have the following properties:
Scope Info
allowsDivision: Allows you to segment the report by this
scope.
label: Display name of the scope.
value: Value of the scope.
139
Reports API Resource Reference
Describe
Standard date filter duration groups
Property
Type
Description
label
String
Display name of the standard date filter grouping. Valid values
are Calendar Year, Calendar Quarter, Calendar Month, Calendar
Week, Fiscal Year, Fiscal Quarter, Day and custom value based
on a user-defined date range.
standardDateFilterDurations Standard date filter
durations[]
Details about each possible relative date filter defined under
the standard date filter grouping.
Standard date filter durations
Property
Type
Description
endDate
String
End date of a date filter.
label
String
Display name of a date filter. Valid date filters are relative date
filters—like Current FY and Current FQ—and custom
date filters.
startDate
String
Start date of a date filter.
value
String
API name of a date filter. Valid date filters are relative date
filters—like THIS_FISCAL_YEAR and
NEXT_FISCAL_QUARTER—and custom date filters.
Report extended metadata
Property
Type
Description
aggregateColumnInfo
Aggregate column
information
Includes all report summaries such as, Record Count, Sum,
Average, Max, Min, and custom summary formulas. Contains
values for each summary listed in the report metadata aggregates.
detailColumnInfo
Detail column
information
Two properties for each field that has detailed data identified by its
unique API name. The detailed data fields are also listed in the report
metadata.
groupingColumnInfo
Grouping column
information
Map of each row or column grouping to its metadata. Contains values
for each grouping identified in the groupingsDown and
groupingsAcross list.
Aggregate column information
Property
Type
Description
label
String
Display name for record count, or the summarized or custom
summary formula field.
140
Reports API Resource Reference
Describe
Property
Type
Description
dataType
String
Data type of the summarized or custom summary formula field.
acrossGroupingContext String
Column grouping in the report where the custom summary formula
is displayed. As this example shows in the JSON response and in
the custom summary formula editor of the matrix report, the
custom summary formula is set at the grand summary level for the
columns.
{
"reportExtendedMetadata" : {
"aggregateColumnInfo" : {
"FORMULA1" : {
"label" : "Stalled Oppty Avg",
"dataType" : "Percent",
"acrossGroupingContext" :
"GRAND_SUMMARY",
"downGroupingContext" :
"GRAND_SUMMARY"
},
}
}
}
downGroupingContext
String
Row grouping in the report where the custom summary formula
is displayed. In this example, the custom summary formula for a
summary report is displayed at the first grouping level This example
is shown in both the JSON response and in the custom summary
formula editor of the summary report.
{
"reportExtendedMetadata" : {
"aggregateColumnInfo" : {
...},
"FORMULA1" : {
"label" : "Average Won",
"dataType" : "Number",
"acrossGroupingContext" : null,
"downGroupingContext" : "TYPE"
},
}
}
}
141
Reports API Resource Reference
Property
Describe
Type
Description
Property
Type
Description
label
String
The localized display name of a standard field, the ID of a custom
field, or the API name of a bucket field that has detailed data.
dataType
String
The data type of the field that has detailed data. Possible values
are:
Detail column information
• string
• boolean
• double
• int
• percent
• currency
• date
• datetime
• time
• picklist
• multipicklist
• id
• reference
• textarea
• phone
• combobox
• url
• email
• html
Grouping column information
Property
Type
Description
label
String
Display name of the field or bucket field used for grouping.
142
Reports API Resource Reference
Execute Sync
Property
Type
Description
dataType
String
Data type of the field used for grouping. Possible values are:
• string
• boolean
• double
• int
• percent
• currency
• date
• datetime
• time
• picklist
• multipicklist
• id
• reference
• textarea
• phone
• combobox
• url
• email
• html
groupingLevel
Integer
Level of the grouping. Value can be:
• 0, 1, or 2. Indicates first, second, or third row level grouping
in summary reports.
• 0 or 1. Indicates first or second row or column level grouping
in a matrix report.
SEE ALSO:
Execute Sync
Execute Async
Execute Sync
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.
143
Reports API Resource Reference
Execute Sync
Resource URL
/services/data//analytics/reports/
Formats
JSON
HTTP Methods
Method
Description
GET
Get report results. See this example.
POST
Get specific results by passing dynamic filters, groupings, and aggregates in the report metadata. See this example.
POST Request Body
Property
Type
Description
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! 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.
buckets
Bucket field
Describes a bucket field.
chart
Chart[]
Details about the chart used in a report.
crossFilters
Cross filter on page
137[]
Cross filters applied to the report.
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.
detailColumns
Array of strings
Unique API names for the fields that have detailed data.
144
Reports API Resource Reference
Execute Sync
Property
Type
Description
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.
Note: When the report is in the My Personal Custom Reports
folder, folderId = userId. When the report is in the Unfiled Public
Reports folder, folderId = orgId.
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.
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.
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.
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.”
{
...
"reportBooleanFilter": "(1 OR 2) AND
3",
"reportFilters": [
{
145
Reports API Resource Reference
Property
Execute Sync
Type
Description
"value":
"Analyst,Integrator,Press,Other",
"column": "TYPE",
"operator": "notEqual"
},
{
"value": "100,000",
"column": "SALES",
"operator": "greaterThan"
},
{
"value": "Small",
"column": "Size",
"operator": "notEqual"
}
]
}
}
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. Value can be:
• TABULAR
• SUMMARY
• MATRIX
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).
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.'
146
Reports API Resource Reference
Property
Execute Sync
Type
Description
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
attributes
Attributes
Key report attributes and child resource URLs.
allData
Boolean
When True, all report results are returned.
When False, results are returned for the same number of rows as
a report run in Salesforce.
Note: For reports that have too many records, use filters to
refine results.
factMap
Fact map
Summary level data or both summary and detailed data for each row
or column grouping. Detailed data is available if hasDetailRows
is true.
Each row or column grouping is represented by combination of row
and column grouping keys defined in Groupings down and
Groupings across.
See these examples of fact map keys.
groupingsAcross
Groupings across
Collection of column groupings, keys, and their values.
groupingsDown
Groupings down
Collection of row groupings, keys, and their values.
hasDetailRows
Boolean
When true,the fact map returns values for both summary level
and record level data.
When false, the fact map returns summary values.
147
Reports API Resource Reference
Execute Sync
Property
Type
Description
reportExtendedMetadata
Report extended
metadata
Additional information about columns, summaries, and groupings.
reportMetadata
Report metadata
Unique identifiers for groupings and summaries.
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.
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.
Property
Type
Description
value
Detail column info
data type
The value of a specified cell.
label
String
Display name of the value as it appears for a specified cell in the
report.
Property
Type
Description
value
Number
Numeric value of the summary data for a specified cell.
label
String
Formatted summary data for a specified cell.
Fact map
Data cells
Aggregates
148
Reports API Resource Reference
Execute Sync
Groupings across
Property
Type
Description
groupings
Groupings[]
Information for each column grouping as a list.
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.
Groupings
• 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.
149
Reports API Resource Reference
Execute Async
Groupings down
Property
Type
Description
groupings
Groupings[]
Information for each row grouping as a list.
SEE ALSO:
Describe
Execute Async
Execute Async
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.
Resource URL
/services/data//analytics/reports//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:
• 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.
150
Reports API Resource Reference
Property
Execute Async
Type
Description
• s! 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.
buckets
Bucket field
Describes a bucket field.
chart
Chart[]
Details about the chart used in a report.
crossFilters
Cross filter on page
137[]
Cross filters applied to the report.
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.
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.
Note: When the report is in the My Personal Custom Reports
folder, folderId = userId. When the report is in the Unfiled Public
Reports folder, folderId = orgId.
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.
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.
hasDetailRows
Boolean
Indicates whether to include detailed data with the summary data.
hasRecordCount
Boolean
Indicates whether the report shows the record count.
151
Reports API Resource Reference
Property
Execute Async
Type
historicalSnapshotDates Array of strings
Description
List of historical snapshot dates.
id
String
Unique report ID.
name
String
Display name of the report.
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.”
{
...
"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"
}
]
}
}
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. Value can be:
• TABULAR
• SUMMARY
• MATRIX
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.
152
Reports API Resource Reference
Execute Async
Property
Type
Description
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).
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
• New if the report run has just been triggered through a request.
• Success if the report ran.
• Running if the report is being run.
153
Reports API Resource Reference
Property
Instances List
Type
Description
• 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 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
• 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.
SEE ALSO:
Describe
Execute Sync
Instances List
Returns a list of instances for a report that you requested to be run asynchronously. Each item in the list is treated as a separate instance
of the report run with metadata in that snapshot of time.
Resource URL
/services/data//analytics/reports//instances
Formats
JSON
HTTP Methods
Method
Description
GET
Return a list of asynchronous runs of a report. See this example.
154
Reports API Resource Reference
Instance Results
Response Body
Property
Type
Description
id
String
Unique ID for a report instance that was requested for a run. The ID is used to
obtain results of the report run for that instance.
status
String
• New if the report run has just been triggered through a POST 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 of the user that created the instance.
hasDetailRows
Boolean
• When false, indicates that summary level data was requested for the
report run.
• When true, indicates that detailed data, which includes summary level
data, was requested for the report run.
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.
requestDate
Date, time string
Date and time when an instance of the report run was requested. Date-time
information is in ISO-8601 format.
SEE ALSO:
Execute Async
Instance Results
Instance Results
Retrieves results for an instance of a report run asynchronously with or without filters. Depending on your asynchronous report run
request, data can be at the summary level or include details.
Resource URL
/services/data//analytics/reports//instances/
155
Reports API Resource Reference
Instance Results
Formats
JSON
HTTP Methods
Method
Description
GET
Retrieves results of an asynchronous report run. See this example.
DELETE
If the given report instance has a status of Success or Error, delete the report instance and return an empty
response body.
GET Response Body
Property
Type
Description
hasDetailRows
Boolean
• When false, report results are at summary level.
• When true, report results are at the record detail level.
allData
Boolean
When True, all report results are returned.
When False, detailed data for the first 2000 report rows are returned.
reportMetadata
Report metadata
Information about the fields used to build the report.
factMap
Fact map
Collection of summary level data or both detailed and summary level data.
attributes
Attributes
Attributes for the instance of the report run.
reportExtendedMetadata Report extended
metadata
Information on report groupings, summary fields, and detailed data columns,
which is available if detailed data is requested.
groupingsDown
Groupings down
Collection of row groupings.
groupingsAcross
Groupings across
Collection of column groupings.
Attributes
Property
Type
Description
id
String
Unique ID for an instance of a report that was run.
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.
156
Reports API Resource Reference
Report List
Property
Type
Description
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.
requestDate
Date, time string
Date and time when an instance of the report run was requested. Date-time
information is in ISO-8601 format.
type
String
Format of the resource.
reportId
String
Unique report ID.
reportName
String
Display name of the report.
SEE ALSO:
Execute Async
Instances List
Report List
Displays a list of up to 200 tabular, matrix, or summary reports that you recently viewed. To get a full list of reports by format, name, and
other fields, use a SOQL query on the Report object. The resource can also be used to make a copy of a report.
Resource URL
Task
List reports
Copy report
URL
/services/data//analytics/reports
/services/data//analytics/reports?cloneId=
Formats
JSON
HTTP Methods
Method
Description
GET
List of reports that were recently viewed by the API user. See this example.
157
Reports API Resource Reference
Report List
Method
Description
POST
Create or clone a report.
To create a new report, see this example.
To clone an existing report, see this example.
GET Response Body
Property
Type
Description
name
String
Report display name.
id
String
Unique report ID.
url
String
URL that returns report data.
describeUrl
String
URL that retrieves report metadata.
instancesUrl
String
Information for each instance of the report that was run asynchronously.
POST Response Body
Property
Type
Description
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! 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.
buckets
Bucket field
Describes a bucket field.
chart
Chart[]
Details about the chart used in a report.
crossFilters
Cross filter on page
137[]
Cross filters applied to the report.
customSummaryFormula
Custom summary
formula
Describes a custom summary formulas.
158
Reports API Resource Reference
Report List
Property
Type
Description
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.
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.
Note: When the report is in the My Personal Custom Reports
folder, folderId = userId. When the report is in the Unfiled Public
Reports folder, folderId = orgId.
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.
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.
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.
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
159
Reports API Resource Reference
Property
Report List
Type
Description
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"
}
]
}
}
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. Value can be:
• TABULAR
• SUMMARY
• MATRIX
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.
160
Reports API Resource Reference
Query
Property
Type
Description
sortBy
Array of strings
API name of the field on which the report is sorted and the direction
of the sort (asc or desc).
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.
Query
Returns report data without saving changes to an existing report or creating a new one.
Resource URL
/services/data//analytics/reports/query
Formats
JSON
HTTP Methods
Method
Description
POST
Run a report without creating or saving the report. Customize your report using reportMetadata that you specify
in the request body. See this example on page 59.
161
Reports API Resource Reference
Query
Request Body
Report metadata
Property
Type
Description
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! 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.
buckets
Bucket field
Describes a bucket field.
chart
Chart[]
Details about the chart used in a report.
crossFilters
Cross filter on page
168[]
Cross filters applied to the report.
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.
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.
Note: When the report is in the My Personal Custom Reports
folder, folderId = userId. When the report is in the Unfiled
Public Reports folder, folderId = orgId.
162
Reports API Resource Reference
Query
Property
Type
Description
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.
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.
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.
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.”
{
...
"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"
}
163
Reports API Resource Reference
Property
Query
Type
Description
]
}
}
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. Value can be:
• TABULAR
• SUMMARY
• MATRIX
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).
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.
164
Reports API Resource Reference
Property
Query
Type
userOrHierarchyFilterId String
Description
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.
Chart
Property
Type
Description
chartType
String
Type of chart.
groupings
String
Report grouping.
hasLegend
Boolean
Indicates whether the report has a legend.
showChartValues
Boolean
Indicates whether the report shows chart values.
summaries
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! 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.
summaryAxisLocations
String
Specifies the axis that shows the summary values. Valid values are
X and Y.
title
String
Name of the chart.
Property
Type
Description
name
String
API name of the field used as a row grouping.
sortOrder
String
Order in which data is sorted within a row grouping. Value can be:
Groupings down
• Asc for ascending order.
• Desc for descending order.
165
Reports API Resource Reference
Query
Property
Type
Description
dateGranularity
String
Interval set on a date field that’s used as a row grouping. Value can
be:
• Day
• Calendar Week
• Calendar Month
• Calendar Quarter
• Calendar Year
• Fiscal Quarter
• Fiscal Year
• Calendar Month in Year
• Calendar Day in Month
sortAggregate
String
Summary field that’s used to sort data within a grouping in a report
that’s in summary format. Applies if you have the Aggregate Sort
feature enabled as part of its pilot program. The value is null when
data within a grouping is not sorted by a summary field. In this
example, data grouped by Account Owner is sorted by the sum of
Annual Revenue.
{
"aggregates": ["s!SALES","RowCount"],
"groupingsDown": [
{
"name": "USERS.NAME",
"sortOrder": "Desc",
"dateGranularity": "None",
"sortAggregate": "s!SALES"
}
]
}
Groupings across
Property
Type
Description
name
String
API name of the field used as a column grouping.
sortOrder
String
Order in which data is sorted within a column grouping. Value can
be:
• Asc for ascending order.
• Desc for descending order.
dateGranularity
String
Interval set on a date field used as a column grouping. Value can
be:
• Day
166
Reports API Resource Reference
Property
Query
Type
Description
• Calendar Week
• Calendar Month
• Calendar Quarter
• Calendar Year
• Fiscal Quarter
• Fiscal Year
• Calendar Month in Year
• Calendar Day in Month
Filter details
Property
Type
Description
column
String
Unique API name for the field that’s being filtered.
isRunPageEditable
Boolean
Indicates if this is an editable filter in the user interface.
operator
String
Unique API name for the condition used to filter a field such as
“greater than” or “not equal to.” Filter conditions depend on the
data type of the field. Valid values are:
• equals
• notEqual
• lessThan
• greaterThan
• lessOrEqual
• greaterOrEqual
• contains
• notContain
• startsWith
• includes
• excludes
• within (DISTANCE criteria only)
value
String
Value by which a field is filtered. For example, the field Age can
be filtered by a numeric value.
For datetime fields, if you make a POST request and specify a
calendar date without including a time, then a default time gets
included. The time defaults to midnight minus the difference
between your timezone and Greenwich Mean Time (GMT). For
example, if you specify 8/8/2015 and your timezone is Pacific
Standard Time (GMT-700), then the API returns
2015-08-08T07:00:00Z.
167
Reports API Resource Reference
Query
Bucket field
Property
Type
Description
bucketType
BucketType
The type of bucket. Possible values are number, percent, and
picklist
developerName
String
API name of the bucket.
label
String
User-facing name of the bucket.
nullTreatedAsZero
Boolean
Specifies whether null values are converted to zero (true) or not
(false).
otherBucketLabel
String
Name of the fields grouped as “Other” (in buckets of BucketType
PICKLIST).
sourceColumnName
String
Name of the bucketed field.
values
Array of
BucketTypeValues
Describes the values included in the bucket field..
Property
Type
Description
label
String
The user-facing name of the bucket.
sourceDimensionValues
String
A list of the values from the source field included in this bucket
category (in buckets of type PICKLIST and buckets of type TEXT).
rangeUpperBound
Double
The greatest range limit under which values are included in this
bucket category (in buckets of type NUMBER).
Property
Type
Description
criteria
Array of Filter details[] Information about how to filter the relatedEntity. Use to relate
the primary entity with a subset of the relatedEntity.
includesObject
Boolean
Specifies whether objects returned have a relationship with the
relatedEntity (true) or not (false).
primaryEntityField
String
The name of the object on which the cross filter is evaluated.
relatedEntity
String
The name of the object that the primaryEntityField is
evaluated against. (The right-hand side of the cross filter).
relatedEntityJoinField
String
The name of the field used to join the primaryEntityField
and relatedEntity.
Bucket field value
Cross filter
168
Reports API Resource Reference
Query
Custom summary formula
Property
Type
Description
label
String
The user-facing name of the custom summary formula.
description
String
The user-facing description of the custom summary formula.
formulaType
String
The format of the numbers in the custom summary formula. Possible
values are number, currency, and percent.
decimalPlaces
Integer
The number of decimal places to include in numbers.
downGroup
String
The name of a row grouping when the downGroupType is
CUSTOM. Null otherwise.
downGroupType
String
Where to display the aggregate of the custom summary formula.
Possible values are all, custom, and grand_total.
acrossGroup
String
The name of a column grouping when the accrossGroupType
is CUSTOM. Null otherwise.
acrossGroupType
String
Where to display the aggregate of the custom summary formula.
Possible values are all, custom, and grand_total.
formula
String
The operations performed on values in the custom summary formula.
Property
Type
Description
rowLimit
Integer
The number of rows returned in the report.
direction
String
The sort order of the report rows.
Top rows
Response Body
Property
Type
Description
attributes
Attributes
Key report attributes and child resource URLs.
allData
Boolean
When True, all report results are returned.
When False, results are returned for the same number of rows as
a report run in Salesforce.
Note: For reports that have too many records, use filters to
refine results.
169
Reports API Resource Reference
Query
Property
Type
Description
factMap
Fact map
Summary level data or both summary and detailed data for each row
or column grouping. Detailed data is available if hasDetailRows
is true.
Each row or column grouping is represented by combination of row
and column grouping keys defined in Groupings down and
Groupings across.
See these examples of fact map keys.
groupingsAcross
Groupings across
Collection of column groupings, keys, and their values.
groupingsDown
Groupings down
Collection of row groupings, keys, and their values.
hasDetailRows
Boolean
When true,the fact map returns values for both summary level
and record level data.
When false, the fact map returns summary values.
reportExtendedMetadata
Report extended
metadata
Additional information about columns, summaries, and groupings.
reportMetadata
Report metadata
Unique identifiers for groupings and summaries.
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.
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.
Fact map
170
Reports API Resource Reference
Query
Data cells
Property
Type
Description
value
Detail column info
data type
The value of a specified cell.
label
String
Display name of the value as it appears for a specified cell in the
report.
Property
Type
Description
value
Number
Numeric value of the summary data for a specified cell.
label
String
Formatted summary data for a specified cell.
Property
Type
Description
groupings
Groupings[]
Information for each column grouping as a list.
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.
Aggregates
Groupings across
Groupings
• 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
171
Reports API Resource Reference
Property
Report Error Codes
Type
Description
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.
Property
Type
Description
groupings
Groupings[]
Information for each row grouping as a list.
Groupings down
Report Error Codes
Errors can occur at the report level. Report-level error messages are returned in the response header.
When a report-level error occurs, the response header contains an HTTP response code and one of the following error messages:
HTTP
Response
Code
Error Message
400
The specified start date of specified for the standard date filter is invalid.
400
The specified end date of specified for the standard date filter is invalid.
400
The column specified for the standard date filter is invalid.
400
The column cannot be a standard date filter because it is not a date column.
400
The duration specified for the standard date filter is invalid.
400
The report folder ID must be a valid folder ID.
400
The report folder ID can't be null.
400
The report name can't be null.
400
Column sorting isn't supported for matrix reports.
400
The sort column name must be from a selected column.
400
The sort column name can't be null.
172
Reports API Resource Reference
Report Error Codes
HTTP
Response
Code
Error Message
400
A report can only be sorted by one column.
400
A snapshot date is not in the correct format. Accepted formats are one of the rolling dates defined or yyyy-MM-dd.
400
The request is invalid because reports that are not historical trending reports cannot have historical snapshot dates.
400
The request is invalid because there are no historical snapshot dates in the request body. Specify historical snapshot
dates, or set historical snapshot dates as an empty array to omit them.
400
Only a report with fewer than 100 columns can be run. The columns are fields specified as detail columns, summaries,
or custom summary formulas. Remove unneeded columns from the report and try again.
400
Can’t run the report because it doesn’t have any columns selected. Be sure to add fields as columns to the report
through the user interface.
400
The request is invalid because there are no filters. Specify filters or set filters as an empty array to omit them.
400
The filter value for ID is incorrect. Specify an ID that is 15 or 18 characters long, such as 006D000000CrRLw
or 005U0000000Rg2CIAS.
400
Specify a valid filterable column because is invalid.
400
Specify a valid condition because is invalid.
400
Filter the date in the correct format. Accepted formats are yyyy-MM-dd'T'HH:mm:ss'Z' and yyyy-MM-dd.
400
The date formula is too large. Specify a reasonable value.
400
The request is invalid because there is no metadata. Specify metadata in the request body.
400
The clone request must contain a valid cloneId parameter.
403
The report can't be deleted because there are one or more dashboards referencing it.
403
You don't have permission to create reports in the given folder.
403
You don’t have permission to edit reports in the given folder.
403
The report definition is obsolete. Your administrator has disabled all reports for the custom object, or its relationships
have changed.
403
You don’t have permission to run reports. Check that you have the Run Reports user permission.
403
You don’t have sufficient privileges to perform this operation.
403
Reports and Dashboards REST API can't process the request because it can accept only as many as requests
at a time to get results of reports run asynchronously.
403
Reports and Dashboards REST API can't process the request because it can accept only as many as requests
at a time to run reports synchronously.
403
You can't run more than reports synchronously every 60 minutes. Try again later.
404
Use a valid URL, for example, /services/data/(apiversion)/analytics/reports/(reportID)/describe, to retrieve report
metadata.
173
Reports API Resource Reference
Report Error Codes
HTTP
Response
Code
Error Message
404
The data you’re trying to access is unavailable.
415
The Reports and Dashboards REST API only supports JSON content type in both request and response bodies. Specify
requests with content type as application/json.
500
We ran into an error when fetching this report’s metadata. Try to re-submit your query.
500
We ran into an error when running this report. Try to re-submit your query.
500
The request body is either invalid or incomplete.
500
Results for this instance are unavailable because the report's metadata has changed from when the report was last
run. To get results, run the report again or undo changes to the report's metadata.
500
The report failed to be deleted.
500
The report failed to be created.
500
The report failed to be saved.
501
You’re requesting data for an unsupported report format.
501
Historical trend data is unavailable in the report format requested. Change the report format to matrix and try again.
174
CHAPTER 6
In this chapter ...
•
Report Type List
•
Report Type
Report Types API Resource Reference
Use the Report Types API to get information about what report types are available in your org. The Report
Types API is available in API version 39.0 and later.
Resources for the Report Types API are available at /services/data//analytics/reporttypes. You can query each resource with an HTTP method.
Resource
Supported Description
HTTP
Method
Report Type List
GET
Returns a list of available
report types.
GET
Returns metadata about
a specified report type.
/services/data//analytics/reportTypes
Report Type
/services/data//analytics/reportType/
175
Report Types API Resource Reference
Report Type List
Report Type List
Return a list of report types.
Syntax
URI
/vXX.X/analytics/reportTypes
Formats
JSON
HTTP methods
Method
Description
GET
Returns a list of report types.
GET Response Body
An array of report type folder objects. Each object contains the following fields:
Property
Type
Description
label
String
The end user-facing name of the report type folder.
reportTypes
reportTypes[]
An array of report types.
reportTypes[]
An array of report type objects. Each object contains the following fields:
Property
Type
Description
describeUrl
String
A URL link to the report type’s metadata.
label
String
The end user-facing name of the report type in the report builder.
type
String
The API name of the report type.
Report Type
Return metadata about a report type.
Syntax
URI
/vXX.X/analytics/reportTypes/type
176
Report Types API Resource Reference
Report Type
Formats
JSON
HTTP methods
Method
Description
GET
Return metadata about a report type
GET Request Body
A notification object with desired changes.
Property
Type
Description
reportMetadata
Report metadata
Unique identifiers for groupings and summaries.
reportTypeMetadata
Report type metadata
Fields in each section of a report type plus filter information for those
fields.
reportExtendedMetadata Report extended
Additional information about summaries and groupings.
metadata
Report extended metadata
Property
Type
Description
aggregateColumnInfo
Aggregate column
information
Includes all report summaries such as, Record Count, Sum,
Average, Max, Min, and custom summary formulas. Contains
values for each summary listed in the report metadata aggregates.
detailColumnInfo
Detail column
information
Two properties for each field that has detailed data identified by its
unique API name. The detailed data fields are also listed in the report
metadata.
groupingColumnInfo
Grouping column
information
Map of each row or column grouping to its metadata. Contains values
for each grouping identified in the groupingsDown and
groupingsAcross list.
Aggregate column information
Property
Type
Description
label
String
Display name for record count, or the summarized or custom
summary formula field.
dataType
String
Data type of the summarized or custom summary formula field.
acrossGroupingContext String
Column grouping in the report where the custom summary formula
is displayed. As this example shows in the JSON response and in
the custom summary formula editor of the matrix report, the
177
Report Types API Resource Reference
Property
Report Type
Type
Description
custom summary formula is set at the grand summary level for the
columns.
{
"reportExtendedMetadata" : {
"aggregateColumnInfo" : {
"FORMULA1" : {
"label" : "Stalled Oppty Avg",
"dataType" : "Percent",
"acrossGroupingContext" :
"GRAND_SUMMARY",
"downGroupingContext" :
"GRAND_SUMMARY"
},
}
}
}
downGroupingContext
String
Row grouping in the report where the custom summary formula
is displayed. In this example, the custom summary formula for a
summary report is displayed at the first grouping level This example
is shown in both the JSON response and in the custom summary
formula editor of the summary report.
{
"reportExtendedMetadata" : {
"aggregateColumnInfo" : {
...},
"FORMULA1" : {
"label" : "Average Won",
"dataType" : "Number",
"acrossGroupingContext" : null,
"downGroupingContext" : "TYPE"
},
}
}
}
178
Report Types API Resource Reference
Report Type
Detail column information
Property
Type
Description
label
String
The localized display name of a standard field, the ID of a custom
field, or the API name of a bucket field that has detailed data.
dataType
String
The data type of the field that has detailed data. Possible values
are:
• string
• boolean
• double
• int
• percent
• currency
• date
• datetime
• time
• picklist
• multipicklist
• id
• reference
• textarea
• phone
• combobox
• url
• email
• html
Grouping column information
Property
Type
Description
label
String
Display name of the field or bucket field used for grouping.
dataType
String
Data type of the field used for grouping. Possible values are:
• string
• boolean
• double
• int
• percent
• currency
179
Report Types API Resource Reference
Property
Report Type
Type
Description
• date
• datetime
• time
• picklist
• multipicklist
• id
• reference
• textarea
• phone
• combobox
• url
• email
• html
groupingLevel
Integer
Level of the grouping. Value can be:
• 0, 1, or 2. Indicates first, second, or third row level grouping
in summary reports.
• 0 or 1. Indicates first or second row or column level grouping
in a matrix report.
Report metadata
Property
Type
Description
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! 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.
buckets
Bucket field
Describes a bucket field.
chart
Chart[]
Details about the chart used in a report.
crossFilters
Cross filter on page
187[]
Cross filters applied to the report.
180
Report Types API Resource Reference
Report Type
Property
Type
Description
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.
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.
Note: When the report is in the My Personal Custom Reports
folder, folderId = userId. When the report is in the Unfiled
Public Reports folder, folderId = orgId.
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.
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.
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.
181
Report Types API Resource Reference
Report Type
Property
Type
Description
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.”
{
...
"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"
}
]
}
}
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. Value can be:
• TABULAR
• SUMMARY
• MATRIX
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.
182
Report Types API Resource Reference
Report Type
Property
Type
Description
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).
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.
Chart
Property
Type
Description
chartType
String
Type of chart.
groupings
String
Report grouping.
hasLegend
Boolean
Indicates whether the report has a legend.
showChartValues
Boolean
Indicates whether the report shows chart values.
summaries
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.
183
Report Types API Resource Reference
Property
Report Type
Type
Description
• m!Amount represents the minimum value of the Amount
column.
• x!Amount represents the maximum value of the Amount
column.
• s! 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.
summaryAxisLocations
String
Specifies the axis that shows the summary values. Valid values are
X and Y.
title
String
Name of the chart.
Property
Type
Description
name
String
API name of the field used as a row grouping.
sortOrder
String
Order in which data is sorted within a row grouping. Value can be:
Groupings down
• Asc for ascending order.
• Desc for descending order.
dateGranularity
String
Interval set on a date field that’s used as a row grouping. Value can
be:
• Day
• Calendar Week
• Calendar Month
• Calendar Quarter
• Calendar Year
• Fiscal Quarter
• Fiscal Year
• Calendar Month in Year
• Calendar Day in Month
sortAggregate
String
Summary field that’s used to sort data within a grouping in a report
that’s in summary format. Applies if you have the Aggregate Sort
feature enabled as part of its pilot program. The value is null when
data within a grouping is not sorted by a summary field. In this
example, data grouped by Account Owner is sorted by the sum of
Annual Revenue.
{
"aggregates": ["s!SALES","RowCount"],
"groupingsDown": [
184
Report Types API Resource Reference
Property
Report Type
Type
Description
{
"name": "USERS.NAME",
"sortOrder": "Desc",
"dateGranularity": "None",
"sortAggregate": "s!SALES"
}
]
}
Groupings across
Property
Type
Description
name
String
API name of the field used as a column grouping.
sortOrder
String
Order in which data is sorted within a column grouping. Value can
be:
• Asc for ascending order.
• Desc for descending order.
dateGranularity
String
Interval set on a date field used as a column grouping. Value can
be:
• Day
• Calendar Week
• Calendar Month
• Calendar Quarter
• Calendar Year
• Fiscal Quarter
• Fiscal Year
• Calendar Month in Year
• Calendar Day in Month
Filter details
Property
Type
Description
column
String
Unique API name for the field that’s being filtered.
isRunPageEditable
Boolean
Indicates if this is an editable filter in the user interface.
operator
String
Unique API name for the condition used to filter a field such as
“greater than” or “not equal to.” Filter conditions depend on the
data type of the field. Valid values are:
• equals
185
Report Types API Resource Reference
Property
Report Type
Type
Description
• notEqual
• lessThan
• greaterThan
• lessOrEqual
• greaterOrEqual
• contains
• notContain
• startsWith
• includes
• excludes
• within (DISTANCE criteria only)
value
String
Value by which a field is filtered. For example, the field Age can
be filtered by a numeric value.
For datetime fields, if you make a POST request and specify a
calendar date without including a time, then a default time gets
included. The time defaults to midnight minus the difference
between your timezone and Greenwich Mean Time (GMT). For
example, if you specify 8/8/2015 and your timezone is Pacific
Standard Time (GMT-700), then the API returns
2015-08-08T07:00:00Z.
Bucket field
Property
Type
Description
bucketType
BucketType
The type of bucket. Possible values are number, percent, and
picklist
developerName
String
API name of the bucket.
label
String
User-facing name of the bucket.
nullTreatedAsZero
Boolean
Specifies whether null values are converted to zero (true) or not
(false).
otherBucketLabel
String
Name of the fields grouped as “Other” (in buckets of BucketType
PICKLIST).
sourceColumnName
String
Name of the bucketed field.
values
Array of
BucketTypeValues
Describes the values included in the bucket field..
186
Report Types API Resource Reference
Report Type
Bucket field value
Property
Type
Description
label
String
The user-facing name of the bucket.
sourceDimensionValues
String
A list of the values from the source field included in this bucket
category (in buckets of type PICKLIST and buckets of type TEXT).
rangeUpperBound
Double
The greatest range limit under which values are included in this
bucket category (in buckets of type NUMBER).
Property
Type
Description
criteria
Array of Filter details[] Information about how to filter the relatedEntity. Use to relate
the primary entity with a subset of the relatedEntity.
includesObject
Boolean
Specifies whether objects returned have a relationship with the
relatedEntity (true) or not (false).
primaryEntityField
String
The name of the object on which the cross filter is evaluated.
relatedEntity
String
The name of the object that the primaryEntityField is
evaluated against. (The right-hand side of the cross filter).
relatedEntityJoinField
String
The name of the field used to join the primaryEntityField
and relatedEntity.
Property
Type
Description
label
String
The user-facing name of the custom summary formula.
description
String
The user-facing description of the custom summary formula.
formulaType
String
The format of the numbers in the custom summary formula. Possible
values are number, currency, and percent.
decimalPlaces
Integer
The number of decimal places to include in numbers.
downGroup
String
The name of a row grouping when the downGroupType is
CUSTOM. Null otherwise.
downGroupType
String
Where to display the aggregate of the custom summary formula.
Possible values are all, custom, and grand_total.
acrossGroup
String
The name of a column grouping when the accrossGroupType
is CUSTOM. Null otherwise.
Cross filter
Custom summary formula
187
Report Types API Resource Reference
Report Type
Property
Type
Description
acrossGroupType
String
Where to display the aggregate of the custom summary formula.
Possible values are all, custom, and grand_total.
formula
String
The operations performed on values in the custom summary formula.
Property
Type
Description
rowLimit
Integer
The number of rows returned in the report.
direction
String
The sort order of the report rows.
Top rows
Report type metadata
Property
Type
Description
categories
Categories[]
All fields in the report type organized by section.
dataTypeFilterOperatorMap
Filter operator
reference
Lists all the possible field data types that can be used to filter
the report. Each data type, such as phone, percent, currency,
or picklist has two properties:
name: Of type string, this is a unique API name for each field
type’s filter criteria. Use this API name in the metadata to
define filter criteria for a report.
label: Of type string, this is the display name for each filter
criteria available to fields of a particular data type. For example,
multipicklist fields can have for filter criteria, “equals,”
“not equal to,” “includes,” and “excludes.” Bucket fields are
considered to be of string data type.
divisionInfo
Division info[]
Default division and list of all possible record-level divisions
that can be used in a report.
scopeInfo
Scope info[]
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.
standardDateFilterDurationGroups Standard date filter List of standard date filters available in reports.
duration groups[]
standardFilterInfos
Array of strings
188
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.
Report Types API Resource Reference
Report Type
Categories
Property
Type
Description
label
String
Display name of a section in the report type under which fields are
organized. For example, in an Accounts with Contacts custom report
type, Account General is the display name of the section that
has fields on general account information.
columns
Column map
Information for all fields in the report type organized under a
particular section’s unique API name.
Property
Type
Description
defaultValue
String
Users are assigned a default division that applies to their newly
created accounts, leads, and custom objects that are enabled for
divisions.
values
String
All division values. Division values have two properties:
Division info
label: Display name of a division.
name: Unique API name of a division.
Column map
Property
Type
Description
label
String
Display name of a field.
filterValues
String array
All filter values for a field, if the field data type is of picklist,
multi-select picklist, boolean, or checkbox. For example, checkbox
fields always have a value of True or False. For fields of other
data types, the filter value is an empty array because their values
can’t be determined. Filter values have two properties:
name: Unique API name for a filter value. Of type string.
label: Display name of a filter value. Of type string.
dataType
String
Data type of the field.
filterable
Boolean
False means that the field is of a type that can’t be filtered. For
example, fields of the type Encrypted Text can’t be filtered.
189
Report Types API Resource Reference
Report Type
Scope Info
Property
Type
Description
defaultValue
String
Default scope of the data on which you run the report.
values
Array of strings
All scope values. Valid values depend on the report type. Scope
values have the following properties:
allowsDivision: Allows you to segment the report by this
scope.
label: Display name of the scope.
value: Value of the scope.
Standard date filter duration groups
Property
Type
Description
label
String
Display name of the standard date filter grouping. Valid values
are Calendar Year, Calendar Quarter, Calendar Month, Calendar
Week, Fiscal Year, Fiscal Quarter, Day and custom value based
on a user-defined date range.
standardDateFilterDurations Standard date filter
durations[]
Details about each possible relative date filter defined under
the standard date filter grouping.
Standard date filter durations
Property
Type
Description
endDate
String
End date of a date filter.
label
String
Display name of a date filter. Valid date filters are relative date
filters—like Current FY and Current FQ—and custom
date filters.
startDate
String
Start date of a date filter.
value
String
API name of a date filter. Valid date filters are relative date
filters—like THIS_FISCAL_YEAR and
NEXT_FISCAL_QUARTER—and custom date filters.
190
CHAPTER 7
In this chapter ...
•
Dashboard List
•
Dashboard Results
•
Dashboard Describe
•
Dashboard Status
•
Dashboard and
Component Error
Codes
Dashboards API Resource Reference
The Dashboards API provides several resources for accessing and refreshing dashboards.
Resources for the Dashboards API are available at /services/data//analytics/dashboards. You can query each resource with an HTTP method (such
as GET). Use these resources to integrate dashboard data directly into your applications.
Resource
Supported Description
HTTP
Method
Dashboard List
GET
Returns a list of recently used dashboards.
POST
Makes a copy of a dashboard.
Dashboard Results GET
Returns the metadata, data, and status for the specified dashboard.
POST
Returns details about specified dashboard components.
PUT
Triggers a dashboard refresh.
PATCH
Saves a dashboard.
DELETE
Deletes a dashboard.
Dashboard Status GET
Returns the status for the specified dashboard.
Dashboard
Describe
Returns metadata for the specified dashboard, including dashboard
components, filters, layout, and the running user.
GET
191
Dashboards API Resource Reference
Dashboard List
Dashboard List
Returns a list of recently used dashboards or clones a dashboard.
Syntax
URI
/vXX.X/analytics/dashboards
Formats
JSON
HTTP methods
Method
Description
GET
Returns a list of dashboards that were recently viewed by the API user. See this example.
POST
Makes a copy of a dashboard. See this example.
Authentication
Authorization: Bearer token
GET Response body
An array of recent dashboard objects. Each object contains the following fields:
Property
Type
Description
id
String
Unique identifier of the dashboard.
name
String
Localized display name of the dashboard.
statusUrl
String
Dashboard status URL.
url
String
Dashboard result URL.
POST Response Body
Uses the same format as the GET and PUT responses for the Dashboard Results resource.
Dashboard Results
Can return metadata, data, and status for the specified dashboard. Can also refresh, save, or delete a dashboard.
Syntax
URI
/vXX.X/analytics/dashboards/dashboardID
192
Dashboards API Resource Reference
Dashboard Results
Or, with optional parameters:
/vXX.X/analytics/dashboards/dashboardID
?runningUser=runningUserID&filter1=filter1ID&filter2=filter2ID&filter3=filter3ID
Formats
JSON
HTTP methods
Method
Description
GET
Returns metadata, data, and status for the specified dashboard. See this example.
POST
Returns details about one or more dashboard components from a specified dashboard. See this example.
PUT
Triggers a dashboard refresh. See this example.
PATCH
Saves a dashboard. See this example.
DELETE
Deletes a dashboard. See this example.
Authentication
Authorization: Bearer token
Parameters
The following optional parameters can be used with the GET and PUT methods:
Parameter Name
Description
runningUser
Identifier of the running user. Gives an error if the user is not allowed to change the running
user, or if the selected running user is invalid.
filter1
Identifier of the selected filter option for the first filter. Gives an error if the filter option is
invalid.
filter2
Identifier of the selected filter option for the second filter. Gives an error if the filter option is
invalid.
filter3
Identifier of the selected filter option for the third filter. Gives an error if the filter option is
invalid.
GET, POST, and PUT Response body
Property
Type
Description
componentData
Component data[]
Ordered array containing data and status for each component of the dashboard.
dashboardMetadata Dashboard metadata
Metadata for the entire dashboard.
193
Dashboards API Resource Reference
Dashboard Results
Attributes
Property
Type
Description
dashboardId
String
Unique identifier of dashboard.
dashboardName
String
Dashboard name.
statusUrl
Url
The URL of the status resource for the dashboard.
type
String
This property is always set to Dashboard.
Property
Type
Description
componentId
String
Unique identifier of the component.
reportResult
Report results
Report metadata and summary data for the dashboard component. Uses
the same data format as the Report API.
status
Component status
Queue and data status of the component.
Component data
Component status
Property
Type
Description
dataStatus
String
Status of the data set of the component. Value can be:
• NODATA: The data set was never generated or is invalid due to a
change in the report.
• DATA: The data set is available and was last refreshed at the
refreshDate.
• ERROR: A component error has occurred. Details can be found in
errorCode, errorMessage, and errorSeverity.
errorCode
String
Unique identifier of error message. This property is only populated in case
of error.
errorMessage
String
Localized error message. This property is only populated in case of error.
errorSeverity
String
Severity of error code and message. Value can be:
• Error
• Warning
This property is only populated in case of error.
refreshDate
Date and time string
Date and time of last refresh in ISO-8601 format.
refreshStatus
String
Refresh status of the component. Value can be:
• IDLE: The component is not currently being refreshed.
• RUNNING: The component is currently being refreshed.
194
Dashboards API Resource Reference
Dashboard Results
Dashboard metadata
Property
Type
Description
attributes
Attributes
Attributes for the dashboard resource, such as name, identifier, and
references to other related resources.
canChangeRunningUser Boolean
Indicates whether the user is allowed to select a specific running user.
Always true for team dashboards.
canUseStickyFilter Boolean
Indicates whether dashboard filters persist after closing the dashboard
(true) or not (false). Filters that persist keep the dashboard filtered
the next time you open it. Filters persist for users on a per-user basis, so if
you apply a filter then it doesn’t persist for other people.
components
Components[]
Ordered array of components in this dashboard.
description
String
Dashboard description.
dashboardType
String
Indicates whether a dashboard is a dynamic dashboard, a dashboard with
running users, or a standard dashboard. Possible values are:
• SpecifiedUser — Dashboard readers view data as though they
are the person specified by runningUser
• LoggedInUser — Dashboard readers view data as themselves.
The dashboard is a dynamic dashboard.
• MyTeamUser — Dashboard readers view data as the person
specified by runningUser by default. If they have the “View All
Data” user permission then they can change the runningUser to
anyone. If they have the “View My Team’s Dashboards” user permission
then they can change the runningUser to people subordinate
to them in the role hierarchy.
developerName
String
Unique API name of the dashboard.
filters
Filters[]
Ordered array of filters for this dashboard. The dashboard can have 0-3
filters.
folderId
String
ID of the folder that contains the dashboard.
id
String
Unique identifier of dashboard.
layout
Layout
Component layout for this dashboard.
name
String
Dashboard name.
runningUser
Running user
The running user, which is either specified at dashboard design time, or
is overridden by the runningUser parameter specified in the GET
request. For dynamic dashboards, this is always the current user.
195
Dashboards API Resource Reference
Dashboard Results
Components
Property
Type
Description
componentData
Integer
Index into the component data array in the response body.
footer
String
Footer of the component.
header
String
Header of the component.
id
String
Unique identifier of the component.
properties
Properties (for Report
component type)
Component properties, including type-specific visualization properties.
Properties (for
Visualforce page
component type)
reportId
String
Unique identifier of the underlying report.
title
String
Title of the component
type
String
Type of the component. Value can be:
• Report
• VisualforcePage
If the component is an SControl, the value is not set.
Filters
Property
Type
Description
errorMessage
String
If there is no error with a dashboard filter, then null. Otherwise, the error
message is returned.
name
String
Localized display name of filter.
options
Filter option
Ordered array of possible filter options.
selectedOption
Integer
Index of the selected option from the options array. This matches the
selection that was made based on the filter1, filter2, or
filter3 parameter. Value is null if no option is selected.
Filter option
Property
Type
Description
alias
String
Optional alias of the filter option.
id
String
Unique identifier of the filter option. Used as a value for the filter1,
filter2, and filter3 parameters.
196
Dashboards API Resource Reference
Dashboard Results
Property
Type
Description
operation
String
Unique API name for the filter operation. Valid filter operations depend
on the data type of the filter field. Value can be:
• equals
• notEqual
• lessThan
• greaterThan
• lessOrEqual
• greaterOrEqual
• contains
• notContain
• startsWith
• includes
• excludes
• within
• between
value
String
Value to filter on. Used for all operations except between.
startValue
String
Start value when using a between operation. Not set for all other
operations.
endValue
String
End value when using a between operation. Not set for all other
operations.
Layout
Property
Type
Description
columns
Columns[]
Dashboard layout columns. Can have 2 or 3 columns, including empty
columns. This property is available only if the dashboard was created using
Salesforce Classic.
components
Components
Layout for dashboards. This property is available only if the dashboard was
created using Lightning Experience.
Columns
Property
Type
Description
components
Integer[]
Ordered list of components in a column (top to bottom). Components
are represented by indices into the array of components in the
dashboard metadata object.
197
Dashboards API Resource Reference
Dashboard Results
Components
Property
Type
Description
colspan
Integer
Width of component in columns. For example, if colspan=3, then
the component spans 3 columns.
rowspan
Integer
Height of component in rows. For example, if rowspan=4, then the
component spans 4 rows.
column
String
Column position on the grid.
row
String
Row position on the grid.
Running user
Property
Type
Description
displayName
String
Display name of running user.
id
String
Unique identifier of running user.
picklistColors
Property
Type
Description
color
String
The color in hexadecimal format used to represent a picklist value.
Properties (for Report component type)
Property
Type
Description
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! 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.
autoSelectColumns
Boolean
Indicates whether groupings and aggregates are automatically selected.
Valid values are true and false.
groupings
String
Report groupings included in the dashboard.
maxRows
Number
Maximum number of rows to be rendered, based on the sort value.
198
Dashboards API Resource Reference
Dashboard Results
Property
Type
Description
sort
Sort
Sorting information for the component.
useReportChart
Boolean
Indicates whether the dashboard component uses the chart as defined
in the report. Valid values are true and false.
visualizationProperties Visualization properties Type-specific visualization properties.
(Chart)
Visualization properties
(Table)
Visualization properties
(Metric)
Visualization properties
(Gauge)
visualizationType
String
Type of the component. Value can be:
• Bar
• Column
• Donut
• Funnel
• Gauge
• Line
• Metric
• Pie
• Scatter
• Table
Sort
Property
Type
Description
column
String
Developer name for a sorted column.
sortOrder
String
Sort order. Value can be:
• asc
• desc
Visualization properties (Chart)
Property
Type
Description
axisRange
String
Range of values specified for the axis.
groupByType
String
Type of second-level grouping.
199
Dashboards API Resource Reference
Dashboard Results
Property
Type
Description
legendPosition
String
Position of legend on the grid. Valid values are bottom, right, and
none.
showValues
Boolean
Indicates whether to include values in the chart. Valid values are true
and false.
Visualization properties (Table)
Property
Type
Description
breakPoints
Break point[]
Break points for the table component.
tableColumns
Table column[]
Columns of the table component.
Visualization properties (Metric)
Property
Type
Description
breakPoints
Break point[]
Break points for the metric component.
metricLabel
String
Label for the metric component.
Visualization properties (Gauge)
Property
Type
Description
breakPoints
Break point[]
Break points for the gauge component.
Break point
Property
Type
Description
aggregateName
String
Aggregate column developer name that the break points have been
applied to.
breaks
Break[]
Break values for a break point.
Break
Property
Type
Description
color
String
A hex value representing the color for the break point.
Note: A color value of black displays only 1 character (0)
instead of 6 characters (000000).
200
Dashboards API Resource Reference
Dashboard Results
Property
Type
Description
lowerBound
Number
Lower bound for the break point.
upperBound
Number
Upper bound for the break point.
Property
Type
Description
column
String
Developer name for the aggregate or grouping column.
isPercent
Boolean
Indicates whether the column value is shown as a percent.
scale
Number
The number of decimal places for the column value.
showTotal
Boolean
Indicates whether the column shows the total.
type
String
Type of the column. Value can be:
Table column
• aggregate
• grouping
Properties (for Visualforce page component type)
Property
Type
Description
pageName
String
Developer name of the Visualforce page.
height
String
Height of the Visualforce page, in pixels.
tableChatterPhotoUrls
Property
Type
Description
chatterPhotoUrl
String
URL pointing to a user's Chatter photo.
PUT Response body
Property
Type
Description
statusUrl
String
URL of the status resource for the dashboard.
POST Request body
Property
Type
Description
componentIds
Array of Strings
Dashboard component ids.
201
Dashboards API Resource Reference
Dashboard Describe
Dashboard Describe
Returns metadata for the specified dashboard, including dashboard components, filters, layout, and the running user.
Syntax
URI
/vXX.X/analytics/dashboards/dashboardID/describe
Formats
JSON
HTTP methods
GET
Parameters
Parameter Description
loadComponentData Optional. Specifies whether or not to return properties for each dashboard component. The default value is true.
Valid values are:
• true — Return component properties.
• false — Don’t return component properties. The properties value instead returns null.
Authentication
Authorization: Bearer token
Example
See this example, Get Dashboard Metadata.
Response body
Property
Type
Description
components
Component[]
Ordered array of components in this dashboard.
filters
Filter[]
Ordered array of filters for this dashboard. The dashboard can have 0 to 3 filters.
layout
Layout
Component layout for this dashboard
runningUser
Running user
The running user, which is either specified at dashboard design time or is
overriden by the runningUser parameter. For dynamic dashboards, this
is always the current user.
202
Dashboards API Resource Reference
Dashboard Describe
Components
Property
Type
Description
componentData
Integer
Index into the component data array in the response body.
footer
String
Footer of the component.
header
String
Header of the component.
id
String
Unique identifier of the component.
properties
Properties (for Report
component type)
Component properties, including type-specific visualization properties.
Properties (for Visualforce
page component type)
reportId
String
Unique identifier of the underlying report.
title
String
Title of the component
type
String
Type of the component. Value can be:
• Report
• VisualforcePage
If the component is an SControl, the value is not set.
Properties (for Report component type)
Property
Type
Description
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! 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.
autoSelectColumns
Boolean
Indicates whether groupings and aggregates are automatically selected.
Valid values are true and false.
groupings
String
Report groupings included in the dashboard.
maxRows
Number
Maximum number of rows to be rendered, based on the sort value.
203
Dashboards API Resource Reference
Dashboard Describe
Property
Type
Description
sort
Sort
Sorting information for the component.
useReportChart
Boolean
Indicates whether the dashboard component uses the chart as defined
in the report. Valid values are true and false.
visualizationProperties Visualization properties Type-specific visualization properties.
(Chart)
Visualization properties
(Table)
Visualization properties
(Metric)
Visualization properties
(Gauge)
visualizationType
String
Type of the component. Value can be:
• Bar
• Column
• Donut
• Funnel
• Gauge
• Line
• Metric
• Pie
• Scatter
• Table
Sort
Property
Type
Description
column
String
Developer name for a sorted column.
sortOrder
String
Sort order. Value can be:
• asc
• desc
Visualization properties (Chart)
Property
Type
Description
axisRange
String
Range of values specified for the axis.
groupByType
String
Type of second-level grouping.
204
Dashboards API Resource Reference
Dashboard Describe
Property
Type
Description
legendPosition
String
Position of legend on the grid. Valid values are bottom, right, and
none.
showValues
Boolean
Indicates whether to include values in the chart. Valid values are true
and false.
Visualization properties (Table)
Property
Type
Description
breakPoints
Break point[]
Break points for the table component.
tableColumns
Table column[]
Columns of the table component.
Visualization properties (Metric)
Property
Type
Description
breakPoints
Break point[]
Break points for the metric component.
metricLabel
String
Label for the metric component.
Visualization properties (Gauge)
Property
Type
Description
breakPoints
Break point[]
Break points for the gauge component.
Properties (for Visualforce page component type)
Property
Type
Description
pageName
String
Developer name of the Visualforce page.
height
String
Height of the Visualforce page, in pixels.
Filters
Property
Type
Description
errorMessage
String
If there is no error with a dashboard filter, then null. Otherwise, the error
message is returned.
name
String
Localized display name of filter.
options
Filter option
Ordered array of possible filter options.
205
Dashboards API Resource Reference
Dashboard Describe
Property
Type
Description
selectedOption
Integer
Index of the selected option from the options array. This matches the
selection that was made based on the filter1, filter2, or filter3
parameter. Value is null if no option is selected.
Filter option
Property
Type
Description
alias
String
Optional alias of the filter option.
id
String
Unique identifier of the filter option. Used as a value for the filter1,
filter2, and filter3 parameters.
operation
String
Unique API name for the filter operation. Valid filter operations depend
on the data type of the filter field. Value can be:
• equals
• notEqual
• lessThan
• greaterThan
• lessOrEqual
• greaterOrEqual
• contains
• notContain
• startsWith
• includes
• excludes
• within
• between
value
String
Value to filter on. Used for all operations except between.
startValue
String
Start value when using a between operation. Not set for all other
operations.
endValue
String
End value when using a between operation. Not set for all other
operations.
206
Dashboards API Resource Reference
Dashboard Status
Layout
Property
Type
Description
columns
Columns[]
Dashboard layout columns. Can have 2 or 3 columns, including empty
columns. This property is available only if the dashboard was created using
Salesforce Classic.
components
Components
Layout for dashboards. This property is available only if the dashboard was
created using Lightning Experience.
Columns
Property
Type
Description
components
Integer[]
Ordered list of components in a column (top to bottom). Components are
represented by indices into the array of components in the dashboard
metadata object.
Property
Type
Description
colspan
Integer
Width of component in columns. For example, if colspan=3, then the
component spans 3 columns.
rowspan
Integer
Height of component in rows. For example, if rowspan=4, then the
component spans 4 rows.
column
String
Column position on the grid.
row
String
Row position on the grid.
Components
Running user
Property
Type
Description
displayName
String
Display name of running user.
id
String
Unique identifier of running user.
Dashboard Status
Returns the status for the specified dashboard.
207
Dashboards API Resource Reference
Dashboard Status
Syntax
URI
/vXX.X/analytics/dashboards/dashboardID/status
Or, with optional parameters:
/vXX.X/analytics/dashboards/dashboardID/status
?runningUser=runningUserID&filter1=filter1ID&filter2=filter2ID&filter3=filter3ID
Formats
JSON
HTTP methods
GET
Authentication
Authorization: Bearer token
Parameters
The following optional parameters can be used with the GET method:
Parameter Name
Description
runningUser
ID of the running user. Gives an error if the user is not allowed to change the running user,
or if the selected running user is invalid.
filter1
ID of the selected filter option for the first filter. Gives an error if the filter option is invalid.
filter2
ID of the selected filter option for the second filter. Gives an error if the filter option is invalid.
filter3
ID of the selected filter option for the third filter. Gives an error if the filter option is invalid.
Response body
Property
Type
Description
componentStatus
Component status with
id[]
Status for each component of the dashboard. The order of the array is the same
as in previous calls, unless the dashboard has changed in the meantime.
Component status with id
Property
Type
Description
componentId
String
Unique ID of the dashboard component.
refreshDate
Date and time string
Date and time of last refresh in ISO-8601 format.
refreshStatus
String
Refresh status of the component. Value can be:
• IDLE: The component is not currently being refreshed.
• RUNNING: The component is currently being refreshed.
208
Dashboards API Resource Reference
Dashboard and Component Error Codes
Dashboard and Component Error Codes
Errors can occur at the dashboard level and at the component level.
Dashboard-level error messages are returned in the response header, and component-level error messages are returned as part of the
component status object.
Dashboard-level errors
When a dashboard-level error occurs, the response header contains an HTTP response code and one of the following error messages:
HTTP
Response
Code
Error Message
400
The running user for this dashboard doesn't have permission to run reports. Your system administrator should select
a different running user for this dashboard.
400
The running user for this dashboard is inactive. Your system administrator should select an active user for this
dashboard.
400
You don't have permission to view data as this user.
400
Your organization has reached the limit for dynamic dashboards, or doesn't have access. Ask your administrator to
enable dynamic dashboards or convert them to dashboards with a specific running user.
400
The selected filter item isn't valid.
400
You can't refresh this dashboard. A refresh is already in progress.
Component-level errors
If an error occurs at the component level, the errorCode, errorMessage, and errorSeverity properties of the component
status field are populated. The errorSeverity property distinguishes between errors and warnings. Errors are blocking issues that
prevent the query from returning any data. Warnings are non-blocking issues; queries will finish, but they might return incomplete data.
The following table shows the possible values for the error fields.
errorCode
errorMessage
errorSeverity
201
This component must have a type and a data source.
Error
202
The source report isn't available; it's been deleted or isn't in a folder accessible to the dashboard's Error
running user.
203
This report can no longer be edited or run. Your administrator has disabled all reports for the
custom or external object, or its relationships have changed.
205
The source report is based on a report type that is inaccessible to the dashboard's running user. Error
208
Unable to run source report because its definition is invalid.
209
Error
Error
Dashboards API Resource Reference
Dashboard and Component Error Codes
errorCode
errorMessage
errorSeverity
209
This report cannot be used as the source for this component. If it is a summary or matrix report, Error
add one or more groupings in the report. If it is a tabular report with a row limit, specify the
Dashboard Settings in the report.
210
This row-limited tabular report cannot be used as the source for this component. Use the
Error
dashboard component editor to specify the data you want to display, or specify the Dashboard
Settings in the report.
211
To use this row-limited tabular report as the source, edit the report and specify the Name and Error
Value under Dashboard Settings. When updating the report, make sure you are the running user
of the dashboard.
212
Groupings and combination charts are not available for a row-limited tabular report. Set “Group Error
By” to None and deselect “Plot Additional Values.”
300
The results below may be incomplete because the underlying report produced too many summary Error
rows, and the sort order of the component is different from the sort order in the underlying
report. Try adding filters to the report to reduce the number of rows returned.
301
Results may be incomplete because the source report had too many summary rows. Try filtering Warning
the report to reduce the number of rows returned.
302
The component can't be displayed because the source report exceeded the time limit.
Warning
303
The component can't be displayed because the source report failed to run.
Error
304
The component can't be displayed because the dashboard filter raises the number of source
report filters above the limit. Reduce the number of report filters and try again.
Error
305
The component can't be displayed because the field(s) you chose for the filter are unavailable.
Error
308
You can’t filter this component because data is in the joined report format. To filter the component, Error
change its report format.
309
The underlying report uses a snapshot date that is out of range.
210
Error
CHAPTER 8
In this chapter ...
•
Analytics Notification
List
•
Analytics Notification
•
Analytics Notification
Limits
Analytics Notifications API Resource Reference
Use the Analytics Notifications API to work set up custom analytics notifications. The Analytics Notifications
API is available in API version 38.0 and later.
Resources for the Analytics Notifications API are available at /services/data//analytics/notifications. You can query each resource with an HTTP method.
Resource
Analytics
Notification List
Supported Description
HTTP
Method
GET
Returns a list of recent notifications.
POST
Create an analytics notification.
PUT
Save changes to the notification as specified in the request body.
DELETE
Delete the notification. Deleted notifications can't be recovered.
/services/data//analytics/notifications
Analytics
Notification
/services/data//analytics/notifications/
Analytics
GET
Notification Limits
Check to see how many more analytics notifications you can create.
/services/data//analytics/notifications/limits
211
Analytics Notifications API Resource Reference
Analytics Notification List
Analytics Notification List
Return a list of analytics notifications (GET) or create an analytics notification (POST).
Syntax
URI
/vXX.X/analytics/notifications?source=waveNotification
Formats
JSON
HTTP methods
Method
Description
GET
Returns a list of analytics notifications.
POST
Create an analytics notification.
Parameters
Parameter Description
source
Required for GET calls. Specifies what type of analytics notification to return. Valid values are:
• lightningSubscribe — report subscriptions
• waveNotification — Wave notifications
recordId
Optional. Return notifications for a single record. Valid values are:
• reportId— Unique report ID
• lensId— Unique Wave lens ID
GET and POST Response Body
An array of notification objects. Each object contains the following fields:
Property
Type
Description
active
Boolean
Indicates whether the notification is being sent (true) or not (false).
configuration
WaveConfiguration[]
Describes details of a Wave notification. Only applicable when source is
waveNotification.
createdDate
DateTime
Date and time when the notification was created (in ISO 8601 format).
deactivateOnTrigger Boolean
Indicates whether the notification is deactivated after it's sent (true) or not
(false). Deactivation doesn't delete the notification.
The default value is false.
212
Analytics Notifications API Resource Reference
Analytics Notification List
Property
Type
Description
id
String
Unique notification ID.
lastModifiedDate DateTime
Date and time when the notification was last modified (in ISO 8601 format).
name
String
Display name of the notification.
recordId
String
Unique ID of the record that the notification describes. Valid values are:
• reportId
• lensId
schedule
Schedule[]
Details about the notification's schedule.
source
String
Indicates the type of notification. Possible values are:
• lightningSubscribe — report subscriptions
• waveNotification — Wave notifications
thresholds
Threshold[]
Specifies what happens when the notification runs. For example, sending an
email with report results.
Schedule
Property
Type
Description
frequency
String
How frequently the notification is invoked. Possible values are:
• daily — Every day
• weekly — One or more days each week
• monthly — One or more days each month
frequencyType
String
Only necessary when frequency is monthly. Possible values are:
• relative — Days which can change month-to-month, as described
by details.
• specific — Fixed monthly dates, as described by details.
details
ScheduleDetail[]
Describes the notification schedule. Varies depending on whether
frequency is daily, weekly, or monthly.
ScheduleDetail (frequency is daily)
Property
Type
Description
time
Integer
The hour of the day at which the notification is invoked. Possible values
are integers from 0 to 23.
213
Analytics Notifications API Resource Reference
Analytics Notification List
ScheduleDetail (frequency is weekly)
Property
Type
Description
time
Integer
The hour of the day at which the notification is invoked. Possible values
are integers from 0 to 23.
daysOfWeek
String[]
The days of the week on which the notification is invoked. Possible values
are:
• mon — Monday
• tue — Tuesday
• wed — Wednesday
• thu — Thursday
• fri — Friday
• sat — Saturday
• sun — Sunday
ScheduleDetail (frequency is monthly, frequencyType is relative)
Property
Type
Description
time
Integer
The hour of the day at which the notification is invoked. Possible values
are integers from 0 to 23.
weekInMonth
String
The week in the month during which the notification is invoked. Possible
values are:
• first — First week
• second — Second week
• third — Third week
• fourth — Fourth week
dayInWeek
String
The day of the week on which the notification is invoked. Possible values
are:
• mon — Monday
• tue — Tuesday
• wed — Wednesday
• thu — Thursday
• fri — Friday
• sat — Saturday
• sun — Sunday
• weekday — Weekday
• weekend — Weekend day
214
Analytics Notifications API Resource Reference
Analytics Notification List
ScheduleDetail (frequency is monthly, frequencyType is specific)
Property
Type
Description
time
Integer
The hour of the day at which the notification is invoked. Possible values
are integers from 0 to 23.
daysOfMonth
Integer[]
The days of the month on which the notification is invoked. Possible values
are integers from 1 to 31, and -1 (which represents the last day of the
month).
Threshold
Property
Type
Description
type
String
Specifies when the notification is invoked (other than date and time criteria).
Possible values are:
• always — Always invoke the notification
• onError — Invoke the notification when there is an error
• condition — Invoke the notification based on criteria described by
conditions
conditions
Condition[]
Describes conditions that govern when the notification is invoked.
actions
Action[]
Specifies what action is taken when the notification is invoked.
Condition
Property
Type
Description
colName
String
The data field which is operated on.
value
String
The comparison value which is used by the operation.
operation
String
The operation which is used to evaluate the condition. Possible values are:
• equal — colName and value are equal
• notEqual — colName and value are not equal
• greaterThan — colName is greater than value
• lessThan — colName is less than value
• greaterThanEqual — colName is greater than or equal to
value
• lessThanEqual — colName is less than or equal to value
215
Analytics Notifications API Resource Reference
Analytics Notification
Action
Property
Type
Description
type
String
The type of action to perform when the notification is invoked. Possible
values are:
• sendEmail — Send an email to recipients
apexConfiguration String
configuration
A basic configuration used for passing arguments to Apex pages.
Config
Returns null. Reserved for future use.
WaveConfiguration
Property
Type
Description
anchor
String
Optional. The Id of the Wave dashboard widget to which the notification is
anchored.
filter
String
Optional. Description of selected filters at the time of notification creation.
query
String
Required. SAQL query which is run when the notification is invoked.
datasets
WaveDataset[]
Required. Collection of Wave datasets referenced by the notification.
WaveDataset
Property
Type
Description
id
String
Required. Id of the Wave dataset.
name
String
Optional. Developer name of the Wave dataset.
namespace
String
Optional. Namespace of the Wave dataset.
POST Request Body
Uses the same format as the GET and POST response body.
Analytics Notification
Save changes to a specific analytics notification (PUT) or delete one (DELETE).
Syntax
URI
/vXX.X/analytics/notifications/analytics notification ID
216
Analytics Notifications API Resource Reference
Analytics Notification
Formats
JSON
HTTP methods
Method
Description
PUT
Save changes to the analytics notification as specified in the request body.
DELETE
Delete the analytics notification. Deleted notifications can't be recovered.
Parameters
Parameter Description
source
Required for GET calls. Specifies what kind of analytic notification to return. Valid values are:
• lightningSubscribe — report subscriptions
• waveNotification — Wave notifications
recordId
Optional. Return notifications for a single record. Valid values are:
• reportId— Unique report ID
• lensId— Unique Wave lens ID
PUT Request Body
A notification object with desired changes.
Property
Type
Description
active
Boolean
Indicates whether the notification is being sent (true) or not (false).
configuration
WaveConfiguration[]
Describes details of a Wave notification. Only applicable when source is
waveNotification.
createdDate
DateTime
Date and time when the notification was created (in ISO 8601 format).
deactivateOnTrigger Boolean
Indicates whether the notification is deactivated after it's sent (true) or not
(false). Deactivation doesn't delete the notification.
The default value is false.
id
String
lastModifiedDate DateTime
Unique notification ID.
Date and time when the notification was last modified (in ISO 8601 format).
name
String
Display name of the notification.
recordId
String
Unique ID of the record that the notification describes. Valid values are:
• reportId
• lensId
217
Analytics Notifications API Resource Reference
Analytics Notification
Property
Type
Description
schedule
Schedule[]
Details about the notification's schedule.
source
String
Indicates the type of notification. Possible values are:
• lightningSubscribe — report subscriptions
• waveNotification — Wave notifications
thresholds
Threshold[]
Specifies what happens when the notification runs. For example, sending an
email with report results.
Schedule
Property
Type
Description
frequency
String
How frequently the notification is invoked. Possible values are:
• daily — Every day
• weekly — One or more days each week
• monthly — One or more days each month
frequencyType
String
Only necessary when frequency is monthly. Possible values are:
• relative — Days which can change month-to-month, as described
by details.
• specific — Fixed monthly dates, as described by details.
details
ScheduleDetail[]
Describes the notification schedule. Varies depending on whether
frequency is daily, weekly, or monthly.
ScheduleDetail (frequency is daily)
Property
Type
Description
time
Integer
The hour of the day at which the notification is invoked. Possible values
are integers from 0 to 23.
ScheduleDetail (frequency is weekly)
Property
Type
Description
time
Integer
The hour of the day at which the notification is invoked. Possible values
are integers from 0 to 23.
daysOfWeek
String[]
The days of the week on which the notification is invoked. Possible values
are:
• mon — Monday
• tue — Tuesday
218
Analytics Notifications API Resource Reference
Property
Type
Analytics Notification
Description
• wed — Wednesday
• thu — Thursday
• fri — Friday
• sat — Saturday
• sun — Sunday
ScheduleDetail (frequency is monthly, frequencyType is relative)
Property
Type
Description
time
Integer
The hour of the day at which the notification is invoked. Possible values
are integers from 0 to 23.
weekInMonth
String
The week in the month during which the notification is invoked. Possible
values are:
• first — First week
• second — Second week
• third — Third week
• fourth — Fourth week
dayInWeek
String
The day of the week on which the notification is invoked. Possible values
are:
• mon — Monday
• tue — Tuesday
• wed — Wednesday
• thu — Thursday
• fri — Friday
• sat — Saturday
• sun — Sunday
• weekday — Weekday
• weekend — Weekend day
ScheduleDetail (frequency is monthly, frequencyType is specific)
Property
Type
Description
time
Integer
The hour of the day at which the notification is invoked. Possible values
are integers from 0 to 23.
daysOfMonth
Integer[]
The days of the month on which the notification is invoked. Possible values
are integers from 1 to 31, and -1 (which represents the last day of the
month).
219
Analytics Notifications API Resource Reference
Analytics Notification
Threshold
Property
Type
Description
type
String
Specifies when the notification is invoked (other than date and time criteria).
Possible values are:
• always — Always invoke the notification
• onError — Invoke the notification when there is an error
• condition — Invoke the notification based on criteria described by
conditions
conditions
Condition[]
Describes conditions that govern when the notification is invoked.
actions
Action[]
Specifies what action is taken when the notification is invoked.
Condition
Property
Type
Description
colName
String
The data field which is operated on.
value
String
The comparison value which is used by the operation.
operation
String
The operation which is used to evaluate the condition. Possible values are:
• equal — colName and value are equal
• notEqual — colName and value are not equal
• greaterThan — colName is greater than value
• lessThan — colName is less than value
• greaterThanEqual — colName is greater than or equal to
value
• lessThanEqual — colName is less than or equal to value
Action
Property
Type
Description
type
String
The type of action to perform when the notification is invoked. Possible
values are:
• sendEmail — Send an email to recipients
apexConfiguration String
configuration
Config
A basic configuration used for passing arguments to Apex pages.
Returns null. Reserved for future use.
220
Analytics Notifications API Resource Reference
Analytics Notification Limits
WaveConfiguration
Property
Type
Description
anchor
String
Optional. The Id of the Wave dashboard widget to which the notification is
anchored.
filter
String
Optional. Description of selected filters at the time of notification creation.
query
String
Required. SAQL query which is run when the notification is invoked.
datasets
WaveDataset[]
Required. Collection of Wave datasets referenced by the notification.
WaveDataset
Property
Type
Description
id
String
Required. Id of the Wave dataset.
name
String
Optional. Developer name of the Wave dataset.
namespace
String
Optional. Namespace of the Wave dataset.
PUT Response Body
An analytics notification object reflecting saved changes.
Uses the same format as the PUT request body.
DELETE Response Body
The analytics notification is deleted, and can't be recovered.
Returns an empty response body.
Analytics Notification Limits
Check to see how many more analytics notifications you can create.
Syntax
URI
/vXX.X/analytics/notifications/limits?source=waveNotification
Formats
JSON
221
Analytics Notifications API Resource Reference
Analytics Notification Limits
HTTP methods
Method
Description
GET
Check how many analytic notifications you have, and the maximum number you can have.
Parameters
Parameter Description
source
Required for GET calls. Specifies what type of analytic notification to return limits for. Valid values are:
• lightningSubscribe — report subscriptions
• waveNotification — Wave notifications
GET Response Body
Property
Type
Description
max
Integer
How many analytics notifications of the type specified by source the user
is allowed to create.
remaining
Integer
How many more analytics notifications of the type specified by source the
user can create before hitting the limit.
222
INDEX
A
Analytics Notifications API
GET a list of analytics notifications 111, 115
GET a list of report types 46
Analytics Notifications API Examples
DELETE delete an analytics notification 115
POST create an analytics notification 113
PUT save an analytics notification 114
D
Dashboards API
filtering results 79
getting dashboard metadata 100
getting list of dashboards 75
getting results 75
getting status 80
refreshing 81
returning details about dashboard components 85
saving a dashboard 81
E
Examples Reports API 3
Examples: Dashboards API 74
I
Introduction 1
R
Reference
Dashboard error codes 209
Dashboard List 191
Dashboard Results 191
Dashboard Status 191
Notifications 211
Report Describe 117
Report Execute 117
Report Instances 117
Report List 117
Report Types 175
Reports and Dashboards REST API
report-level errors 172
Reports API Examples
POST create a report 4
Requirements and limitations 2
Resources
DELETE analytics notification 216
DELETE report 118
Detailed results 57, 143
Fact map 57
Filter report results 57, 143
GET analytics notifications limits 221
GET analytics notifications list 212
Get basic report metadata 129
GET dashboard describe 202
GET dashboard list 192
GET dashboard results 192
GET dashboard status 207
Get extended report metadata 129
Get recent reports list 157
GET report data 57, 143
GET report instance results 155
GET report instances 154
GET report type list 176
GET report type metadata 176
PATCH report 118
POST analytics notifications list 212
POST report data 57, 143
POST report instance 150, 154
POST Report Query Resource 161
PUT analytics notification 216
run report asynchronously 150
Summary level results 57, 143
S
Salesforce Reports and Dashboards REST API
asynchronous 51–52
dashboard, clone 108
dashboard, delete 109
filter reports 52
GET request 34, 42, 51
list report runs 51
POST request 52
recently viewed 55
report data 34
report list 55
report metadata 42
report, clone 72
report, delete 73
report, query 59
report, save 71
223
Index
Salesforce Reports and Dashboards REST API (continued)
synchronous 52
224
Source Exif Data:
File Type : PDF File Type Extension : pdf MIME Type : application/pdf PDF Version : 1.4 Linearized : Yes Create Date : 2017:03:11 07:49:20Z Author : salesforce.com, inc. Date Time Generated : 2017-03-10T23:49:08.182-08:00 Trapped : False DRC : 206.14 Modify Date : 2017:03:11 07:49:20Z Format : application/pdf Title : Salesforce Reports and Dashboards REST API Developer Guide Creator : salesforce.com, inc. Producer : XEP 4.20 build 20120720 Creator Tool : Unknown Page Count : 228 Page Mode : UseOutlinesEXIF Metadata provided by EXIF.tools