Shlink icon

Shlink

Interact with Shlink URL Shortener API

Actions12

Overview

This node integrates with the Shlink URL Shortener API to retrieve visit data associated with short URLs. Specifically, the "Get by Short URL" operation fetches visits made to a particular short URL identified by its short code. This is useful for tracking and analyzing traffic on shortened links.

Common scenarios include:

  • Monitoring how many times a specific short URL has been visited.
  • Filtering visits within a certain date range to analyze trends over time.
  • Integrating visit data into workflows for reporting or triggering actions based on visit activity.

For example, you could use this node to get all visits to a promotional short URL during a campaign period, then send a summary report via email.

Properties

Name Meaning
Short Code The unique short code of the URL whose visits you want to retrieve.
Return All Whether to return all visit records or limit the number of results returned.
Limit Maximum number of visit records to return if not returning all.
Additional Fields Optional filters including:
• Start Date — filter visits after this date.
• End Date — filter visits before this date.

Output

The output is a JSON array where each item represents a visit record to the specified short URL. Each visit object typically contains details such as timestamp, visitor information, referrer, user agent, and other metadata provided by the Shlink API about that visit.

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Shlink URL Shortener API.
  • The node expects the base URL of the Shlink instance to be configured in the credentials.
  • Network access to the Shlink API endpoint is necessary.

Troubleshooting

  • Invalid or missing API credentials: Ensure the API key and base URL are correctly set in the node credentials.
  • Short Code not found: If the specified short code does not exist, the API will return an error. Verify the short code is correct.
  • Date filter format issues: Make sure the start and end dates are valid ISO 8601 datetime strings.
  • Pagination limits: When Return All is false, the number of visits returned is limited by Limit. Increase the limit or enable Return All to get more data.
  • Network errors: Check connectivity to the Shlink server and that the base URL includes the correct protocol (http/https).

Links and References

Discussion