Salesforce Reports and Dashboards REST API Developer Guide

Salesforce Reports and Dashboards REST API
Examples: Reports REST API Resources
Examples: Dashboards REST API Resources
Examples: Analytics Notifications REST API
Reports API Resource Reference
Report Types API Resource Reference
Filter Operators API Resource Reference
Dashboards API Resource Reference
Analytics Notifications API Resource Reference
Analytics Folders API Resource Reference
Folder Share Information
Folder Shares
Folder Share by ID
Folder Share Recipients
PDF

Newer Version Available

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

Analytics Folders API Resource Reference

Use the Analytics Folders API to perform operations on report and dashboard folders. The Folders API is available in API version 41.0 and later.

Resources for the Analytics Folders API are available at /services/data/<latest API version>/folders. You can query each resource with an HTTP method.

Resource Supported HTTP Method Description
Folder Share Information

/services/data/<latest API version>/folders/<folderid>

GET

Returns the supported folder share types and the recipient and shares URLs.

Folder Shares

/services/data/<latest API version>/folders/<folderid>>/shares

GET

PUT

POST

Extracts a list of current folder shares (GET), adds new shares (POST), or replaces existing shares (PUT).

Folder Share by ID

/services/data/<latest API version>/folders/<folderid>/shares/<shareid>

GET

PATCH

DELETE

For a specified share ID, extracts the folder share information (GET), updates access level on the share (PATCH), or deletes the share (DELETE).

Folder Share Recipients

/services/data/<latest API version>/folders/<folderid>/share-recipients?shareType=<shareType>

GET

Returns a list of folder share recipients.