| Created date | Updated date | Affects version | Fix version |
|---|---|---|---|
|
| Management Portal |
Description
When exporting large data sets using the Report Export API endpoints in the Blancco Management Portal the response is split into multiple separate responses. To achieve this use of a special header as part of the request response named "X-BLANCCO-CURSOR" is required.
This page will explain the pagination in more detail and help with the usage of the cursor to fetch all the data when working with larger data sets.
Page size limitations
Default page size is limited to a maximum of 100 reports. If the request returns more reports the data is split into multiple responses and using the cursor is required to fetch all the requested reports.
Page size can also be set as a request parameter within the JSON payload if you are using the "Export Reports (POST)" endpoint. The "size" parameter defines the number of returned reports and allows values between 1-10. As an example using "size" value of 5 returns 5 reports per page and each page of 5 reports needs to be requested separately using the cursor.
Cursor header
In case the request response return a lot of data it is split into multiple separate request responses. When this happens the request response headers will include a "X-BLANCCO-CURSOR" header with a value similar to "1234567890123,1234a12b-1234-123a-ab1c-123456a1b12c"
x-blancco-cursor: 1234567890123,1234a12b-1234-123a-ab1c-123456a1b12c
If the header is not available on the request response all the (remaining) data was returned within the request. This is how you know you have requested the last available page of data.
Including the cursor to the API request
If your initial request return the above mentioned header not all the matching reports were included in the provided response and you will need request the rest of the reports by including the cursor to the next request.
When you send your initial Report Export request the first page of data will be provided as the response.