GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API to post usage data tracking events to the endpoint `/api/v4/usage_data/track_events`. It is useful for scenarios where you want to send custom usage or event tracking data to GitLab for analytics or monitoring purposes. For example, it can be used to track feature usage or user actions within GitLab projects.

Use Case Examples

  1. Sending a POST request to track a custom event in GitLab usage data.
  2. Automating the reporting of usage metrics to GitLab for analysis.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication when making 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 request is sent, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to POST for this operation.
Parameter Schema Defines the schema for the parameters expected in the request body for the operation postApiV4UsageDataTrackEvents.
Request Body Schema Defines the schema for the request body content for the operation postApiV4UsageDataTrackEvents.
Request Path The API endpoint path for posting usage data track events, fixed to /api/v4/usage_data/track_events.

Output

JSON

  • response - The JSON response returned from the GitLab API after posting the usage data tracking events.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the GitLab API key credential is valid and has the necessary permissions to post usage data.
  • Verify the baseUrl is correct and accessible from the network where the node runs.
  • Check that the request body matches the expected schema for usage data tracking events to avoid validation errors.

Links

Discussion