GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves metric definitions related to usage data from the GitLab API (version 4). It is useful for users who want to access detailed metrics about their GitLab usage, such as file paths included in the metric definitions. A practical example is fetching usage metrics to analyze project activity or resource consumption within a GitLab instance.

Use Case Examples

  1. Fetch usage data metric definitions including file paths to analyze project metrics.
  2. Retrieve basic usage data metric definitions without file paths for a summary overview.

Properties

Name Meaning
Skip Authentication Determines whether to skip the authentication process for the API request.
Authentication Specifies the authentication method to use, 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 Additional query parameters for the API request, such as 'include_paths' to include file paths in the metric definitions.

Output

JSON

  • metric_definitions - The list of metric definitions retrieved from the GitLab usage data API.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has the necessary permissions to access usage data.
  • Verify the baseUrl is correct and accessible from the network where the node is running.
  • If skipping authentication, ensure the API endpoint allows unauthenticated requests, otherwise the request will fail.
  • Check that the 'include_paths' query parameter is correctly formatted as a boolean string ('true' or 'false').

Links

Discussion