Cannot use Search API with cursor-based Pagination

3 Comments

  • Christopher Kennedy
    Zendesk Developer Advocacy
    Hi Jon,
     
    The benefits of cursor based pagination are greater with large data sets.  But with the Search API, a given query will only return a maximum of 1,000 records - even if there are more than 1,000 matching records.
     
    For queries that return more than 1,000 records, you may use the Export Search Results endpoint which supports cursor based pagination.
     
    Best,
    0
  • Jon I.

    Thanks for your reply Christopher Kennedy

    So, what's the difference between the classic Search and Export Search Results?

    0
  • Christopher Kennedy
    Zendesk Developer Advocacy
    Hi Jon,
     
    No problem - happy to clarify.  The differences between the two endpoints revolve around their ability to handle large datasets.
     
    The List Search Results endpoint is intended to return smaller result sets (up to 1,000).  There's also a bit more flexibility as a single query can return matches to different object types (tickets, organizations, users, etc.)
     
    The Export Search Results endpoint is intended to return larger result sets.  A query will only return matches from one object type (specified in the request).  This endpoint also has a rate limit of 100 requests per minute.
     
    Best,
    0

Please sign in to leave a comment.

Powered by Zendesk