By default, the Impala API returns a maximum of 50 items from a given endpoint. The limit parameter allows you to increase or decrease this number as needed.
Currently, there is a hard cap of 300 results per page, though we do advise making use of reasonable limits and pagination in the event that a hard cap is implemented in the future.
Pagination properties
These can be found inside of the _meta property.
| Parameter | Type | Description |
|---|---|---|
hasNext |
boolean | Is there a next page? |
next |
string | The cursor position for the next page. |
hasPrevious |
boolean | Is there a previous page? |
previous |
string | The cursor position for the previous page. |
In the case that there are no results, hasNext and hasPrevious will be false and next and previous will not be present.
Here's an example of what this might look like:
{
"data": [],
"_meta": {
"pms": "IMPALA_PMS",
"next": "eyIkb2lkIjoiNWIzZjc1ZjE3NjVhOTMwMDdkYmQwNjhmIn0",
"hasNext": true,
"previous": "eyIkb2lkIjoiNWIzZjc1ZjE3NjVhOTMwMDdkYmQwNjhmIn0",
"hasPrevious": true
}
}Query Parameters
The following properties can be passed along as query parameters in order to influence the pagination behaviour:
| Parameter | Type | Description |
|---|---|---|
limit |
integer | Number of results per page, default 50. |
next |
string | The next page to load, can be obtained from _meta.next. |
previous |
string | The previous page to load, can be obtained from _meta.previous. |