Skip to main content

report

Retrieves a report that was previously generated with the generateReport mutation. Note that if the report is still being processed that the status field on the ReportExecution object will indicate this, and the data in the results field will be null. Thus, this method can be polled to determine when report generation is complete.

The results field returns data inline and is intended for bounded responses only. A page that is too large to return inline is rejected with a BadRequestError whose code is REPORT_RESULTS_TOO_LARGE. Select downloadLinks instead to retrieve large pages and large exports as CSV files.

report(
  page: Int
  where: ReportFilterInput!
): ReportResponse

Arguments​

report.page ● Int scalar​

Specifies the page of the report to be returned, if report generation is complete. Since reports may be large, they are generated page-by-page with a standard row count and and thus don't use cursor-based paging, instead they use page-number based retrieval to return the specified pre-generated page. The page number is 1-based. If this value is not specified, the first page will be returned in the results field if report generation is complete.

The results field is intended for bounded pages only. If the requested page is larger than the inline limit, the query returns a BadRequestError instead; see the results field for details.

report.where ● ReportFilterInput! non-null input​

The ReportFilterInput specifies which report execution to retrieve.

Type​

ReportResponse union​

The possible return types when retrieving a generated report. A BadRequestError with the code REPORT_RESULTS_TOO_LARGE means the requested page is too large to return in results; it is not retryable. Request that page through downloadLinks instead.