Пагинация

Разделение ответа на несколько страниц. Рекомендуется использовать пагинацию в запросах, в ответах на которые ожидается большой объем данных.

Формат запроса

Начиная с версии API 1.0.0 для запросов, в ответах на которые ожидается большой объем данных, доступна пагинация — возможность разделять ответ по страницам. В основном это запросы для методов получения списков — list.

Примечание. Пагинация доступна только для запросов, в описании которых есть пометка доступна пагинация.

К запросу добавляются 2 параметра:

https://api.adfox.ru/v1/API.php
 ? [offset=<integer>]
 & [limit=<integer>]
Query-параметры
offset

Какое количество объектов в списке необходимо пропустить.

Значение по умолчанию: 0.

limit

Количество объектов на одной странице.

Значение по умолчанию: 10.

Пример

Запрос списка всех кампаний, где на каждой странице будет выведено по 25 кампаний.

https://api.adfox.ru/v1/API.php?object=account&action=list&actionObject=campaign&offset=0&limit=25

Запрос для просмотра второй страницы с 25 кампаниями:

https://api.adfox.ru/v1/API.php?object=account&action=list&actionObject=campaign&offset=25&limit=25

Формат ответа

В ответе на запрос добавлен блок пагинации с информацией о том, сколько всего страниц, на какой странице сейчас находится ответ, общее количество объектов, сколько объектов выведено на данной странице и ссылки на первую, предыдущую, следующую и последнюю страницы.

Пример блока пагинации в ответе:

...
<links>
 <first>
  <![CDATA[
   https://api.adfox.ru/v1/Api.php?&&object=account&action=list&actionObject=campaign&offset=0&limit=5
  ]]>
 </first>
 <prev>
  <![CDATA[
   https://api.adfox.ru/v1/Api.php?&&object=account&action=list&actionObject=campaign&offset=0&limit=5
  ]]>
 </prev>
 <next>
  <![CDATA[
   https://api.adfox.ru/v1/Api.php?&&object=account&action=list&actionObject=campaign&offset=10&limit=5
  ]]>
 </next>
 <last>
  <![CDATA[
   https://api.adfox.ru/v1/Api.php?&&object=account&action=list&actionObject=campaign&offset=80&limit=5
  ]]>
 </last>
<limit>5</limit>
<offset>5</offset>
<total_pages>17</total_pages>
<page>2</page>
<total_rows>85</total_rows>
<rows>5</rows>
...

Параметры блока пагинации

first

Ссылка на первую страницу.

prev

Ссылка на предыдущую страницу.

next

Ссылка на следующую страницу.

last

Ссылка на последнюю страницу.

total_pages

Общее число страниц.

page

Номер страницы, на которой сейчас находимся.

total_rows

Общее количество объектов.

rows

Сколько объектов выведено на странице.