Skip to main content

Project overview API (Power BI)

The project overview endpoints provide aggregated reporting data for a project. They correspond to the Reports > Project Overview view in the SUM-IT web application.

Parameters (template)

These names match the parameters in sum-it-api.pbit. They map to the generate request as projectId, fromDate, toDate, and customColumns (see the project_overview query in Power Query).

ParameterRequiredDescription
project_idYesProject id filter used to filter project overview and progress data.
proj_overview_from_dateNoThe date from which the data for project overview should be searched. Date format: YYYY-MM-DD.
proj_overview_to_dateNoThe date to which the data for project overview should be searched. Date format: YYYY-MM-DD.
proj_overview_custom_columnsNoCustom columns from which the report should be generated. This parameter is optional; when left empty, the default report at the lowest granularity level will be returned. If the parameter is provided, only data for the selected fields will be included in the report.

API reference

For more details, please refer to the API documentations:

API documentation: Generate project overview

Used to create or refresh an overview payload (for example after changing filters or when the API expects a generation step). Check the API schema for request body fields and required headers.

API documentation: Get project overview

Retrieves the current project overview for the given path or query parameters. Use this when you only need to read the latest overview that is already available for the project.