Shlink icon

Shlink

Interact with Shlink URL Shortener API

Actions12

Overview

This node integrates with the Shlink URL Shortener API to manage tags associated with short URLs. Specifically, the "Tag" resource with the "Get Many" operation allows users to retrieve multiple tags from their Shlink instance. This is useful for scenarios where you want to list all tags or a subset of tags applied to short URLs, for example, to analyze tag usage or to display available tags in a dashboard.

Practical examples:

  • Fetching all tags to populate a dropdown menu for filtering short URLs.
  • Retrieving a limited number of tags to monitor popular categories or campaigns.
  • Automating reports that include tag statistics by pulling tag data regularly.

Properties

Name Meaning
Return All Whether to return all tags or only up to a given limit.
Limit Maximum number of tags to return (only used if "Return All" is false).

Output

The output is a JSON array where each item represents a tag object retrieved from the Shlink API. Each tag object typically contains metadata about the tag such as its name and possibly usage statistics depending on the API response.

No binary data is returned by this operation.

Example output structure (simplified):

[
  {
    "name": "marketing",
    "shortUrlsCount": 10
  },
  {
    "name": "campaign2024",
    "shortUrlsCount": 5
  }
]

Dependencies

  • Requires an API key credential for authenticating with the Shlink API.
  • The node expects the base URL of the Shlink instance to be configured in the credentials.
  • The Shlink API version used is v3.
  • Network access to the Shlink server must be available from the n8n environment.

Troubleshooting

  • Common issues:

    • Incorrect or missing API key credential will cause authentication failures.
    • Invalid base URL or network connectivity issues will prevent API calls.
    • Request limits may be hit if the Shlink server restricts pagination or rate limits.

  • Error messages:

    • HTTP errors with status codes like 401 indicate authentication problems; verify API key and permissions.
    • 404 errors may occur if the endpoint URL is incorrect; ensure the base URL and resource path are correct.
    • Timeout or network errors suggest connectivity issues; check network settings and Shlink server availability.

  • Resolution tips:

    • Double-check the API key and base URL configuration in the node credentials.
    • Use the "Return All" option carefully to avoid large data loads that might time out.
    • Review Shlink server logs for more detailed error information if requests fail.

Links and References

Discussion