Paging
Some Flare APIs use a common pattern for paging results.
This pattern pairs the from
request parameter to the next
response field.
Using from
and next
paging
First Request
Perform the first request without specifying from
.
This indicates that you want the first page of results.
Subsequent Requests
Use the next
response field from your last response as the
value for your following request’s from
parameter.
This indicates that you want the next page of results.
All parameters other than from
must remain the same as the original request.
If next
is missing from the last response (or is null
), this means that you viewed all pages.
Empty pages (no results) does not mean you viewed all pages. Some filters (like ignored events) will cause empty pages. This means that you should still request the next page even after receiving an empty page.
The from
Request Parameter
Used to indicate where to resume paging.
Should be empty on the first request.
The next
Response field
The value that should be included in the next request’s from
parameter.
Most of the time, this is an opaque string.
The value of the next
response field can be saved for long periods of time.
For example if you want to export all results for a given search and then resume
to fetch new results the next day.
End-to-End Examples
These are end-to-end examples in various programming languages.
Was this page helpful?