Optimizing API Calls
Effective use of filtering, paging and field selection.
It is highly recommended that calls to any APIs that retrieve multiple records, also make use of paging, filtering and field selection to reduce the payload returned by Vitruvi for performance and minimizing system load.
As a rule of thumb, API calls should complete and return the necessary data in no more than 1 to 3 seconds. If calls are taking longer than this, it is recommended that the paging, filtering and field selection be modified accordingly to reduce the result payloads.
This document refers solely to the query_ APIs and the Raw_ APIs. Other APIs may or may not implement paging. For further information on those APIs, please refer to the Swagger OpenAPI documentation at https://<workspace>.api.vitruvi.cc.
Unlike paging and field selection, filtering uses a different syntax for raw APIs vs _query APIs.
Updated over 1 year ago