Troubleshooting: Custom Reports Via APIs

The API call times out.

If the API call isn't processed under 60 seconds, the call times out and you'll receive an error.

Cause	Solution
You have too many joins across datasets.	Limit the number of joins used across datasets.
You're retrieving a report with more than 20 fields.	Restrict the number of fields in a report to 10 to 20 fields maximum. If the field count is more than 20, use SFTP to retrieve the report.
You have an irregular data shape. Example: You have a large number of nested organizations.	Avoid retrieving abnormally large datasets.
You have a report without a filter	Use appropriate filters to contain growth in data size. Example: Retrieve data modified with a filter defining a smaller time frame, such as Yesterday or Today .
You've made a request within minutes of a prior request. This is especially true for reports that return large volumes of data or have multiple joins.	Avoid making multiple API request within a short timespan.
You're retrieving reports with multiple pages of data.	The reporting APIs are intentionally designed to return paged datasets. This is a standard constraint for all VNDLY HTTP based APIs. To avoid this issues: Use limit (number of rows to return) and offset (starting row count) to retrieve a single page of data. Limit the number of fields included in the report. Use SFTP instead of the reporting API to retrieve large reports without the need for paging.

You're getting performance issues retrieving data from your Production tenants, but not your Test tenants.

Performance issues may not be apparent in Test tenants because the data load will be less in a Test tenant than a Production tenant.

Solutions:

Verify report performance after production go-live to verify the results are similar to Test tenants.

Load the Test tenant with test data with a size representative of production load.

Plan for scaling in production. Factor in the anticipated load size and complexity of a report with production data. Reports that execute near the threshold will likely exceed that as the program matures or after going live.