Pagination for Reports

Pagination is also useful when a report is rather large and its content is split into report pages. The AE REST API paginates these report pages.

Limit Parameters

max_results

Defines the maximum number of entries (report pages) returned.

Default value: 1

If this parameter is set to zero (0), no entries are returned.
start_at

Defines the number of the start page (entry/report page) returned.

Default value: 1

If this parameter is not defined, the entries returned start with the first report page. If the value defined is larger than the number of entries available, no information is returned, because the request exceeds the range of report pages available.

Example
- ...exectutions/{run id}/reports/REP returns the whole report (all report pages)
- ...exectutions/{run id}/reports/REP?max_results=3 returns the first chunk of three (3) report pages (report pages 1, 2, and 3)
- ...exectutions/{run id}/reports/REP?max_results=3&start_at=4 returns the second chunk of three (3) (report pages 4, 5, and 6)
- ...exectutions/{run id}/reports/REP?start_at=2 returns all report pages except the first one

Important! The AE REST API can only request the content of reports available in the AE database. A job report is stored in the database only if the Store to: Database option has been selected in the Job Report section of the job definition page. This option is selected by default.