UseIncrementalAPI
Specifies whether to use the Zendesk Incremental API for retrieving data.
Possible Values
Auto, True, FalseData Type
string
Default Value
"Auto"
Remarks
The Incremental API is optimized for retrieving large datasets that are filtered by date columns (for example, UpdatedAt, CreatedAt, or StartTime) in the following tables: Tickets, TicketEvents, TicketMetrics, TicketMetricEvents, Calls, Articles, Users, and Organizations.
Incremental API Configuration
| Auto | Enables the use of Incremental API if the authenticated user's role supports it. The driver uses the Incremental API for supported entities unless the query is better suited for another API. For example, filtering by ticket status works best using the Search API. |
| True | Enables the use of Incremental API regardless of the authenticated user's role or applied filters. |
| False | Disables the use of Incremental API. |