GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation fetches metric definitions related to usage data from the GitLab API (v4). It is useful for users who want to retrieve detailed information about various usage metrics tracked by GitLab, such as for monitoring or analytics purposes. For example, a user might use this node to get definitions of metrics to understand what data is available for usage reporting or to include file paths in the metric definitions if needed.

Use Case Examples

  1. Retrieve all usage data metric definitions from a GitLab instance to analyze usage patterns.
  2. Fetch metric definitions including file paths to get detailed insights into usage data.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, typically an API key credential.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request (GET, POST, PUT, DELETE, HEAD, PATCH).
Query Parameters Additional query parameters for the API request, such as including file paths in the metric definitions.

Output

JSON

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

Dependencies

  • GitLab API with authentication token or API key

Troubleshooting

  • Ensure the baseUrl is correct and accessible; otherwise, the API request will fail.
  • If authentication is required and skipped, the request may be unauthorized and return an error.
  • Verify that the query parameter 'include_paths' is a valid boolean string ('true' or 'false') to avoid request errors.
  • Common error messages include 401 Unauthorized (check API credentials) and 404 Not Found (check the API path and baseUrl).

Links

Discussion