Reporting API v1 - using updatedDate filters

Introduction

This article explains how to use updatedDate filters in the Reporting API v1 to retrieve only recently modified data. Understanding these filters will help you optimize API performance and implement efficient incremental data loading strategies.

How updatedDate filters work

Several Reporting API endpoints allow you to restrict the data received based on when it was last updated. This is useful for scenarios where only recent changes are needed, such as incremental data loads. In most cases, using these filters will also improve API performance by reducing the volume of data transferred.

Using updatedDateFrom and updatedDateTill parameters

To receive a filtered response, use the updatedDateFrom and updatedDateTill parameters by entering dates in the yyyy-MM-dd format.

This will return only records that were updated between January 1, 2024, and January 15, 2024.

Limitations

When using updatedDate filters, be aware of the following limitations:

Summary

Use updatedDateFrom and updatedDateTill parameters in Reporting API endpoints to filter data by last update date, entering dates in yyyy-MM-dd format. This approach improves API performance and enables efficient incremental data loading by retrieving only recently modified records. Be aware that the updatedDateTime field may update when related entities change even if the API response content remains unchanged, and that changes to industryTypes and isVendor fields in the Get Organization Details endpoint do not trigger updatedDateTime updates.