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.

To improve performance, the export process runs in parallel, splitting a single report into multiple files. The number of files generated depends on the report size and cannot be determined beforehand. After the export is complete, you can review the output to see how many files were created.

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

Because the export process runs in parallel to improve performance, multiple files may be generated. The number of files can vary regardless of the report size.

To learn more about the number of files and their UUIDs (Universally Unique Identifiers), see getExportStatus.

See Also