About reports and report runs

Most requests in the Report Library API interact with the resource for a report or a report run. Reports and report runs use the same data structure and have many of the same attributes, with a few key differences. Understanding these differences can help you know which resource to use in your API requests.

The Get report history endpoint returns a list of records for both scheduled reports and completed report runs.

Reports

When you call the Create report endpoint, you create a record for a new report. The report record is the template for the data you want to get from your CertCentral account. The report record defines the report type, file format, schedule, and columns (data fields) to include in the report. The report record also defines the filters and data sources (subaccounts and divisions) to use in the report.

Each report has a unique report_identifier (UUID). Use the report_identifier with these endpoints:

Report runs

Each time a report generates results, it creates a new object with details about the report run. Report runs can be scheduled, or you can start them on demand. Successful report runs create files containing the results of the report. You can download these files from your CertCentral account.

Each report run has a unique report_run_identifier (UUID). Use the report_run_identifier with these endpoints:

On-demand vs. scheduled reports

When you schedule a report to run on-demand, the first report run starts the moment the report is created. This means:

  • For on-demand reports, the report object created when you build a report contains the report_run_identifier of the first report run.
  • For reports scheduled to run periodically, the report object created when you build the report does not include a report_run_identifier value.