Skip to main content

Report

Report contains information about a generated report.

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

Fields​

Report.downloadLinks ● [DownloadLink!] list object​

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.

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).

Implemented By​

ReportResponse union