GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node interacts with the GitLab API to post usage data track events. It is useful for sending event tracking data to GitLab's usage data endpoint, which can help in monitoring and analyzing usage patterns within GitLab projects or instances. For example, it can be used to log custom events or user actions for analytics purposes.

Use Case Examples

  1. Sending a POST request to GitLab's /api/v4/usage_data/track_events endpoint to log a custom event.
  2. Tracking user interactions or feature usage within a GitLab project by posting event data.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication.
baseUrl The base URL for the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to GET but can be set to POST, PUT, DELETE, HEAD, or PATCH.
Parameter Schema Defines the schema for the parameters expected in the request body for the postApiV4UsageDataTrackEvents operation.
Request Body Schema Defines the schema for the request body, which is initially null and can be set dynamically.
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 track events.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the GitLab API authentication credential is correctly configured and has the necessary permissions to post usage data.
  • Verify the baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab.
  • Check that the request body matches the expected schema for the postApiV4UsageDataTrackEvents operation to avoid validation errors.
  • Common error messages may include authentication failures, permission denied, or invalid request body format. Resolving these involves checking credentials, permissions, and request payload structure.

Links

Discussion