REST API Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Introduction to REST API
Quick Start
Examples
Generating an OpenAPI 3.0 Document for sObjects REST API (Beta)
Reference
Versions
Resources by Version
Limits
Describe Global
sObject Basic Information
sObject Describe
sObject Get Deleted
sObject Get Updated
sObject Named Layouts
sObject Rows
sObject Rows by External ID
sObject Blob Get
sObject ApprovalLayouts
sObject Single Approval Process
sObject CompactLayouts
sObject Layouts
sObject Layouts for an Object With Multiple Record Types
sObject Global Publisher Layouts
sObject PlatformAction
sObject Quick Actions
sObject Specific Quick Actions
sObject Quick Action Details
sObject Quick Action Default Values
sObject Quick Action Default Values by ID
sObject Rich Text Image Get
sObject Relationships
sObjects Suggested Articles
sObjects Suggested Articles by ID
sObject User Password
sObject Self-Service User Password
Platform Event Schema by Event Name
Platform Event Schema by Schema ID
Get AppMenu Types
AppMenu Items
AppMenu Mobile Items
Compact Layouts
Consent
Consent Write
Embedded Service Configuration Describe
Invocable Actions
Invocable Actions Custom
Invocable Actions Standard
List View Basic Information
List View Describe
List View Results
List Views for an Object
Support Knowledge with REST API
Parameterized Search
Portability
Process Approvals
Process Rules
Process Rule for an sObject
Process Rule List for an sObject
Product Schedules
Query
Query More Results
QueryAll
QueryAll More Results
Query Performance Feedback (Beta)
Quick Actions
Recent List Views
Recently Viewed Items
Record Count
sObject Relevant Items
Get Knowledge Language Settings
Search
Search Scope and Order
Search Result Layouts
Lightning Toggle Metrics
Lightning Usage by App Type
Lightning Usage by Browser
Lightning Usage by Page
Lightning Usage by FlexiPage
Lightning Exit by Page Metrics
Salesforce Scheduler Resources
Search for Records Suggested by Autocomplete and Instant Results
Search Suggested Article Title Matches
Search Suggested Queries
Salesforce Surveys Translation Resources
Tabs
Themes
Composite
Composite Graph
Composite Batch
sObject Tree
sObject Collections
PDF

Query Performance Feedback (Beta)

Analyzes the performance of a specified SOQL query, report, or list view without executing it.

Use the explain parameter in a request to get a response that details how Salesforce processes your query, report, or list view and how to optimize it.

The Query Performance Feedback resource is available in API version 30.0 and later.

This feature is a Beta Service. Customer may opt to try such Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms.

Note

Syntax

URI
/services/data/vXX.X/query?explain=query
Formats
JSON, XML
HTTP Method
GET
Authentication
Authorization: Bearer token
Parameters
Parameter Description
explain

A SOQL query, report, or list view that you want to analyze. To analyze a query, provide the full query in the request. To analyze a report or list view, provide the ID of the report or list view.

If the SOQL query string is invalid, a MALFORMED_QUERY response is returned. If the report or list view ID is invalid, an INVALID_ID response is returned.
Response body
The response body contains one or more plans that can be used to execute the query, report, or list view. The plans are sorted from most optimal to least optimal. Each plan has the following information:
Name Type Description
cardinality number The estimated number of records the query would return, based on index fields, if any.
fields string[] If the leading operation type is Index, these values are the index fields used for the query. Otherwise, the value is null.
leadingOperationType string The primary operation type that can use to optimize the query. This type can be one of these values:
  • Index—The query uses an index on the query object.
  • Other—The query uses optimizations internal to Salesforce.
  • Sharing—The query uses an index based on the user’s sharing rules. If there are sharing rules that limit which records are visible to the current user, those rules can optimize the query.
  • TableScan—The query scans all records for the query object, and doesn’t use an index.
notes feedback note[] An array of one or more feedback notes. Each note contains:
  • description— A detailed description of a part of the optimization. This description can include information on optimizations that can’t be used and why they can’t used.
  • fields— An array of one or more fields used for the optimization.
  • tableEnumOrId— The table name for the fields used for the optimization.
This response field is available in API version 33.0 and later.
relativeCost number The cost of this query compared to the SOQL selective query threshold. A value greater than 1.0 means the query isn’t selective. For more information on selective queries, see Working with Very Large SOQL Queries in the Apex Developer Guide.
sobjectCardinality number The approximate count of all records in your organization for the query object.
sobjectType string The name of the query object, such as Merchandise__c.

Resources for Executing SOQL Queries