GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation fetches metric definitions from the GitLab API's usage data endpoint. It is useful for retrieving detailed information about available usage metrics, including optionally the file paths associated with those metrics. This can help users monitor and analyze GitLab usage data programmatically, for example, to integrate usage metrics into dashboards or automate reporting.

Use Case Examples

  1. Retrieve all available usage data metric definitions from a GitLab instance to understand what metrics can be tracked.
  2. Fetch metric definitions including file paths to get detailed insights into usage data for auditing or optimization purposes.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request, default is GET.
Query Parameters Collection of query parameters for the API request, including 'include_paths' to specify if file paths should be included in the metric definitions.

Output

JSON

  • metric_definitions - Array of metric definitions retrieved from the GitLab API, potentially including file paths if requested.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has sufficient permissions to access usage data metrics.
  • Verify the baseUrl is correct and accessible from the network where the node runs.
  • If the API returns errors, check the HTTP method and query parameters for correctness.

Links

Discussion