GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation fetches metric definitions related to API v4 usage data from GitLab. It is useful for users who want to retrieve detailed metrics about their GitLab API usage, including optional file path information in the metric definitions. Practical applications include monitoring API usage patterns, analyzing performance metrics, and integrating GitLab usage data into reporting or analytics workflows.

Use Case Examples

  1. Retrieve all API v4 usage data metric definitions from GitLab.
  2. Fetch metric definitions including file paths to get detailed insights into usage metrics.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated endpoints.
Authentication Type of authentication used for the request, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance to send the request to, default is https://gitlab.com.
Method HTTP method used for the request, default is GET.
Query Parameters Additional query parameters for the request, including 'include_paths' to specify if file paths should be included in the metric definitions.

Output

JSON

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

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the baseUrl is correct and accessible to avoid connection errors.
  • If authentication is required and skipped, the request may fail with authorization errors.
  • Verify that the 'include_paths' query parameter is correctly formatted as a string ('true' or 'false').
  • Common error messages include 401 Unauthorized (check API key), 404 Not Found (check endpoint path), and 500 Internal Server Error (server-side issues).

Links

Discussion