Skip to main content

Report

Report contains information about a generated report.

type Report {
  downloadLinks: [DownloadLink!]
  execution: ReportExecution!
  results: ReportResults
}

Fields​

If requested, this field will be populated with links to download the individual CSV pages of the report. Importantly, the behavior of this field is a bit different compared to the results field based on the page input parameter. If the page input parameter was not specified at all, this field will include links for ALL pages of the report (as these are just links, paging is not as much of a concern here). If the page number WAS specified, this field will only include the link to that single page. Use this field, not results, to retrieve any page that is too large to be returned inline.

Report.execution ● ReportExecution! non-null object​

This field contains metadata about the current status of report generation, and fields originally passed in to generate the report.

Report.results ● ReportResults object​

Contains the actual data result rows for the report. Note that if reportExecution.status is not SUCCEEDED, this field will be null. The results here will only be for the page requested (if page was not specified, the first page will be returned).

Inline results are intended for bounded responses. A page is returned here only if it has no more than the configured maximum number of data rows (10,000 by default; the CSV header is not counted) and is within the configured maximum size in bytes. These limits can differ between environments. The limits apply to the single page requested, not to the whole report. A page that exceeds either limit is not returned, and the query responds with a BadRequestError whose code is REPORT_RESULTS_TOO_LARGE and whose retryable is false, so repeating the same request will not succeed.

To get a page that is too large, run the report query again for the same page without selecting results, and select downloadLinks instead. Each link downloads that page as a CSV file. Select files (or the rowCount and byteSize fields on downloadLinks) to see how large each page is before you request it. Large reports should always be retrieved through downloadLinks.

Implemented By​

ReportResponse union