Pagination

Many Reporting API endpoints can return large result sets. To help you work efficiently and avoid timeouts or memory issues, the API uses pagination. This means results are returned in chunks ("pages"), and you can request the next page using a link provided in the response.

Different endpoints use different pagination approaches. The sections below explain how they work and what to expect when integrating with them.

How Pagination Works

Server-Driven Paging

Some endpoints automatically apply paging on the server. These endpoints have a default page size which is also the maximum page size. Refer table below for exact details. If more data is available, the response includes an @odata.nextLink property. You can call the URL in nextLink to retrieve the next page.

What you need to do: Follow the @odata.nextLink until it is no longer present. It's still possible to use client-driven paging on these endpoints if desired (see below).

Client-Driven Paging (Manual)

All endpoints support client-driven paging. This is done using the OData $top and $skip query parameters. The $top value controls how many items are on each page (the page size) and $skip controls how many items to skip.

Endpoints

The table below outlines which endpoints use which paging style, including any applicable default page size.

FAQ - Parallel Requests

Q: Can I request data from multiple different endpoints in parallel?

A: Yes, you can request data from multiple endpoints in parallel.

Q: Can I request multiple pages from the same endpoint in parallel?

A: No this is not permitted, to protect the service and other customers from misuse. This will result in you being rate limited - you will receive a 429 error code. You must iterate over pages for a given endpoint sequentially.