Save as PDF

Using the Offset and Limit Parameters

Overview

The offset and limit API parameters work together to limit the number of records returned and page through the result set, functioning as a method of pagination.

  • Offset specifies how many records will be skipped, beginning with record 0.
  • Limit specifies the maximum number of records that will be returned by the API.

Select the applicable tab for your edition of Responsive.

  • If the filter criteria for the API will return 1,500 records and you only want to see the top 5 responses, you could set the limit to 5 and the offset to 0. The API will return records 0 - 4.

    This provides a way to paginate your results so you can manage the number of records returned.

    Example 1

    • Offset = 0
    • Limit = 100
    • Number of records that meet the search criteria = 1,500

    The API will return the first 100 records that meet the criteria.

    Example 2

    • Offset = 100
    • Limit = 100
    • Number of records that meet the search criteria = 1,500

    The API will return the second set of 100 records that meet the criteria.

  • Essentials features are subscription-based and may not be available for all users. Contact your account manager, or accountmanagers@responsive.io, for more details.

    If the filter criteria for the API will return 1,500 records and you only want to see the top 5 responses, you could set the limit to 5 and the offset to 0. The API will return records 0 - 4.

    This provides a way to paginate your results so you can manage the number of records returned.

    Example 1

    • Offset = 0
    • Limit = 100
    • Number of records that meet the search criteria = 1,500

    The API will return the first 100 records that meet the criteria.

    Example 2

    • Offset = 100
    • Limit = 100
    • Number of records that meet the search criteria = 1,500

    The API will return the second set of 100 records that meet the criteria.

Was this article helpful?

/