Reporting on block model data

Introduction

The Reporting API allows users to generate reports on the data in a block model. It uses three main entity types:

• The Report Specification. This defines the report structure, such as the data columns and how they are computed, the category columns, cut-off values, and density information.
• The Reporting Job. This represents the activity of applying a Report Specification to a particular block model version, to produce a Report Result.
• The Report Result. This is the output report data, summarising a particular block model version.

The Reporting API also supports comparisons between two versions of a block model, based on a Report Specification.

Please see the Reports section of the Block Model API schema for the details of endpoint URLs, and for request and response details.