Product Updates

API Pagination Method Change

October 10, 2024
Improved

We’ve made an important change to our Platform API’s pagination method to ensure a more predictable and consistent experience.

What’s Changing?

Previously, our API used a scroll-based pagination method, which meant that each request could yield different results based on the user's current "scroll window." This approach made it difficult to maintain statelessness, a key characteristic of REST APIs.

With this update, we’ve transitioned to a cursor-based pagination method that is fully stateless. Now, the cursor will directly represent a specific set of results.

This means that:

  • When you provide the same cursor, you will consistently receive the same set of results.
  • The cursor acts as a unique identifier for a particular "page" of data. Each time you request data with a cursor, we return the next set of results, along with a new cursor for subsequent requests.
  • This change ensures that repeated requests with the same cursor yield the same results, maintaining the predictability of a stateless API.

What Does This Mean for You?

If you’re using the API, you’ll continue to receive a cursor with each response, which should be included in subsequent requests to fetch the next batch of data. The key difference now is that the cursor’s role is more precise—it directly corresponds to the specific data set it represents.

Why the Change?

This shift allows our API to maintain a stateless nature, ensuring that each request is independent of any prior "scroll window." It improves consistency and simplifies the integration process for developers.

Action Required

If you are already using our cursor-based endpoints, make sure to adjust your implementation to leverage this updated behavior. This will help ensure you receive the expected results with each request.