Best Practice for Performant Use
Here we have provided some high-level facts for performant use with out integration options, when and how these are applied will be advised within the integration documentation itself. For more detailed use cases please view that documentation.
Querying and Filters
In order to return specific data for your integration, our API's have specific data-points which you can query, e.g. Last and First name of a contact.
Depending on the API you may also find additional filtering options such as STARTS WITH or CONTAINS.
API's are not intended for regular batch ETL processes however are suitable for delta change polling with an initial data load.
Pagination and Response Size
Our API's are designed to perform for integration but also to ensure system stability, therefore all the results from the API calls are paged.
Your integration can call subsequent pages after the first results have been returned.
In addition you can specify the maximum number of results per page, therefore if you only need to first 20 records, you can specify this rather than returning 100 or 1000.
Please note that there is a total number of records per page, by default this is 20 records, however certain API endpoints may have different settings which will be detailed in the documentation.