SonarQube icon

SonarQube

Consume SonarQube and SonarCloud Web API

Actions8

Measure → Search History

AI-generated

Overview

This node interacts with the SonarQube API to search the history of measures for a specified component (project) and selected metric keys. It allows filtering the measure history by branch and date range, making it useful for tracking metric changes over time in a project. For example, it can be used to analyze the evolution of code quality metrics or technical debt in a software project over a specific period.

Use Case Examples

  1. Track the history of code coverage metrics for a project branch over the last year.
  2. Retrieve the historical values of specific quality metrics to analyze trends and improvements.

Properties

Name Meaning
Component Key The key of the component (project) for which to search measure history. This is a required identifier for the project.
Metric Key Names or IDs A list of metric keys or IDs (up to 15) to specify which metrics' history to retrieve. Users can select from a list or specify IDs directly.
Additional Fields Optional filters including branch name, and date range ('From' and 'To') to limit the measure history results.

Output

JSON

  • measures - The measure history data returned from the SonarQube API, containing historical metric values for the specified component and metrics.

Dependencies

  • Requires an API key credential for SonarQube API authentication, including the server URL and optionally an organization key.

Troubleshooting

  • Common issues include invalid or missing component key, exceeding the maximum number of metric keys (15), or incorrect date formats in the 'From' and 'To' fields.
  • Error messages may indicate authentication failures if the API key or server URL is incorrect, or request errors if required parameters are missing or invalid.
  • To resolve errors, verify the component key, metric keys, and date formats. Ensure the API credentials are correctly configured and have sufficient permissions.

Links

Discussion