Shlink icon

Shlink

Interact with Shlink URL Shortener API

Actions12

Overview

This node interacts with the Shlink URL Shortener API to retrieve visit data associated with a specific tag. The "Get by Tag" operation under the "Visit" resource fetches visits that are tagged with a given label. This is useful for analyzing traffic or user engagement related to URLs grouped by tags.

Common scenarios include:

  • Tracking visits for marketing campaigns identified by tags.
  • Monitoring user activity on sets of URLs categorized by tags.
  • Generating reports on visits filtered by custom tags over specific time periods.

For example, you could use this node to get all visits tagged as "summer-sale" to analyze how many users clicked links related to a seasonal promotion.

Properties

Name Meaning
Tag The tag name used to filter visits. Only visits associated with this tag will be returned.
Return All Whether to return all matching results or limit the number of results returned.
Limit Maximum number of visit records to return if "Return All" is false.
Additional Fields Optional filters including:
- Start Date: Filter visits after this date.
- End Date: Filter visits before this date.

Output

The node outputs an array of visit objects in the json field. Each object represents a single visit record associated with the specified tag and may contain details such as timestamp, referrer, user agent, and other metadata provided by the Shlink API.

If the "Return All" option is enabled, the node paginates through all available visits matching the criteria and returns them as a combined list.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Shlink URL Shortener API.
  • The base URL of the Shlink instance must be configured in the credentials.
  • The node makes HTTP requests to the Shlink REST API endpoints.

Troubleshooting

  • Invalid or missing API credentials: Ensure the API key and base URL are correctly set in the node credentials.
  • Tag not found or no visits returned: Verify the tag exists and has associated visits within the specified date range.
  • API request failures: Network issues or incorrect base URL can cause request errors. Check connectivity and URL correctness.
  • Limit vs Return All confusion: If "Return All" is false but the limit is too low, fewer visits than expected will be returned. Adjust accordingly.

Error messages from failed HTTP requests include status codes and response data logged for debugging.

Links and References

Discussion