GitLab API

GitlabTool
Join our community

Actions905

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, including optionally the file paths associated with those metrics. Practical applications include monitoring and analyzing GitLab usage statistics for project management, auditing, or reporting purposes.

Use Case Examples

  1. Retrieve all usage data metric definitions from a GitLab instance to understand what metrics are available for monitoring.
  2. Fetch usage data metric definitions including file paths to get detailed insights into usage patterns at the file level.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip authentication when making the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication. Hidden unless Skip Authentication is false.
baseUrl The base URL of the GitLab instance to which the API request is sent. Defaults to https://gitlab.com.
Method The HTTP method used for the API request. Defaults to GET.
Query Parameters Collection of query parameters for the API request. Includes 'include_paths' to specify whether to include file paths in the metric definitions.

Output

JSON

  • metric_definitions - Array of metric definitions retrieved from the GitLab API, including details about each usage metric.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the GitLab API credentials are correctly configured and have sufficient permissions to access usage data metric definitions.
  • If the API request fails, verify the baseUrl is correct and reachable.
  • Check that the 'include_paths' query parameter is correctly formatted as a boolean string ('true' or 'false').

Links

Discussion