API | Постраничная выгрузка
Применяется почти для всех GET запросов которые возвращают список с возможностью постраничной выгрузки.
Параметры запроса#
| Поле | Обязательное | Описание |
|---|---|---|
limit | Нет | Количество запрашиваемых элементов. По-умолчанию 10 |
offset | Нет | Количество элементов которые надо пропустить. По-умолчанию 0 |
with_count | Нет | При указании true вернет кол-во элементов в данной выборке (поле count). Может увеличивать время ответа. |
force_count | Нет | Используется вместе с параметром with_count. При указании true сбросит кеш кол-ва и пересчитает его. Может увеличивать время ответа. |
Структура ответа#
| Поле | Описание |
|---|---|
results | Массив с элементами выборки. Если кол-во элементов массива меньше, чем значение поля limit в запросе, значит это последние элементы в выборке. |
count | Общее кол-во элементов. null если не указан параметр with_count=true. |
next | Ссылка на следующую страницу. null если слеующая страница пустая. |
prev | Ссылка на предыдущую страницу. null если предыдущую страница пустая. |
Примеры запросов#
Чтобы выгрузить постранично все записи, нужно делать запросы последовательно, до тех пор пока в ответе, в поле results не будет данных меньше чем запрошено (limit).
Например, если в выборке есть 25 записей, и выгрузку идет по 10 элементов (limit=10), то получится 3 запроса:
- Запрашиваем 10 элементов с нулевым смещением:
?limit=10&offset=0. В ответе получаем 10 элементов. - Запрашиваем следующие 10 элементов, смещение уже будет равно 10:
?limit=10&offset=10. В ответе опять получаем 10 элементов. - Запрашиваем следующие 10 элементов, смещение уже будет равно 20:
?limit=10&offset=20. На этот раз, в ответе уже 5 элементов, и так как вернулось меньше чем запрошено, значит далее уже элементов нет, постраничную выгрузку можно завершать.