Limits for Salesforce Spiff Reporting API

Salesforce Spiff API reports behave differently from other Spiff custom reports, and the Reporting API endpoints have limits on the number of requests you can make and the size of exported files.

  • Spiff Reporting API endpoints are compatible with only custom reports that have the API Report type.
  • API reports don't support some features of other Spiff custom reports, such as pivoting, grouping, column filtering, and exporting to .xlsx format. You can export API reports to .csv or .csv.gz format only.

To help prevent abuse or misuse of the Spiff Reporting API, each endpoint enforces rate limits on the number of requests that you can make. See Salesforce Spiff Reporting API for specific rate limits for each endpoint.

The size of a report and the export format that you specify determine how many files the Reporting API exports.

The requestExport endpoint's compressed parameter determines the export format.

  • When compressed is false or unspecified, this endpoint exports one or more .csv files.
  • When compressed is true, this endpoint exports one or more .csv.gz files, which are .csv files compressed using gzip.

This API exports files to a cloud storage location, spiff-attachments-{id}/custom-report-exports/{filename}.

You can also download an API report directly from the Reporting tab in Spiff. In this case, the API report always downloads as one file.

If the report's size is less than 500 MB, only one .csv file is created. If a report exceeds 500 MB, multiple .csv files are created, up to 4 separate files or 2 GB total.

Compressing the report can reduce the output file size and shorten the time required to create the file.

If the report's size is less than 500 MB, only one .csv.gz file is created. If the report exceeds 500 MB, multiple .csv.gz files are created, but fewer than 4 separate files. The exact number of files depends on the compression at run time.

See Also