Five tips to deal with notorious list APIs

Body

List APIs can take a toll on the performance of an application if they are not well tuned.

If a list API is taking time, generate the SQL DEBUG trace for that API to review what is causing the delay.
Chances are the query being fired on the database to retrieve the list is the culprit. In some cases, an index may be needed to speed up this process.

Set a crisp output template for the API, delete the parameters that are not being used.
Refer to the java docs to generate the supported parameters for the output template.

Use a narrow search criteria to reduce the burden on the DB.
For example, restrict order search with just first name and last name, pass the email ID or phone number along with the first name and last name for a more efficient search.

Cap the number of records returned for the list API wherever applicable.
The application provides the parameter MaximumRecords in the input to the API.

Understand how often the list API is being triggered and the time taken by the API
Use the yfs_statistics_detail table. The table provides the minimum, average and maximum response time taken by the API along with the number of invocations for the API.