YOURLS integration

Overview

YOURLS (Your Own URL Shortener) is a self-hosted PHP-based URL shortening service. This tool interacts with the YOURLS API to shorten long URLs into short links, expand short URLs back to their original form, and retrieve click statistics for shortened URLs. YOURLS must be self-hosted and the API must be enabled with a signature token for authentication.

Node Type

Action — processes input items and produces output

Input / Output

Direction	Port(s)
Input	Input
Output	Output, Error

Credentials

This tool requires YOURLS API credentials. See the Credentials Guide for setup instructions.

Resources

Resource	Value
URL	url

Operations

Operation	Value	Description
Expand	expand	Expand a short URL to its original long URL
Shorten	shorten	Shorten a long URL
Stats	stats	Get click statistics for a short URL

Parameters

URL: Shorten

Parameter	Type	Required	Default	Description
URL	string	Yes	—	The long URL to shorten. Supports expressions like {{ $json.longUrl }}.
Additional Fields	collection	No	{}	Optional extra values sent with the shorten request.
— Keyword	string	No	—	Custom keyword (slug) for the short URL. If not specified, YOURLS will generate one automatically.
— Title	string	No	—	Title for the custom short URL. Used for display/organizational purposes.

URL: Expand

Parameter	Type	Required	Default	Description
Short URL	string	Yes	—	The short URL or keyword to expand back to the original long URL. Supports expressions.

URL: Stats

Parameter	Type	Required	Default	Description
Short URL	string	Yes	—	The short URL or keyword to get click statistics for. Supports expressions.

All Operations

Parameter	Type	Required	Default	Description
Max Concurrency	number	No	10	Maximum number of items to process concurrently.

Output Data

One output item per input item — no operation fans out. The fields of the YOURLS API response are merged onto the top level of the item JSON; anything already on the item passes through, and binary data is forwarded unchanged.

Operation	What lands on the item
shorten	The shorturl response from YOURLS, including the generated short link, its keyword and the original URL
expand	The expand response, including the long URL the keyword points at
stats	The link object from the response is unwrapped first, so its click-count fields land directly on the item rather than nested under link

Reference the result downstream by expression, for example {{ $json.shorturl }}.

Example Configuration

Shorten a URL:

{
  "type": "yourls",
  "parameters": {
    "resource": "url",
    "operation": "shorten",
    "url": "https://www.example.com/very/long/path/to/some/resource"
  }
}

Shorten a URL with a custom keyword and title:

{
  "type": "yourls",
  "parameters": {
    "resource": "url",
    "operation": "shorten",
    "url": "https://www.example.com/very/long/path/to/some/resource",
    "additionalFields": {
      "keyword": "example-page",
      "title": "Example Resource Page"
    }
  }
}

Expand a short URL:

{
  "type": "yourls",
  "parameters": {
    "resource": "url",
    "operation": "expand",
    "shortUrl": "abc123"
  }
}

Get statistics for a short URL:

{
  "type": "yourls",
  "parameters": {
    "resource": "url",
    "operation": "stats",
    "shortUrl": "abc123"
  }
}

Shorten one URL per incoming item, taking the link and the title from the item:

{
  "type": "yourls",
  "parameters": {
    "resource": "url",
    "operation": "shorten",
    "url": "{{ $json.longUrl }}",
    "maxConcurrency": 15,
    "additionalFields": {
      "title": "{{ $json.pageTitle }}"
    }
  }
}

Error Handling

Mode	Behavior
stop	Halts workflow on first error
continue	Skips failed items, passes successful ones through
errorPort	Routes failed items to Error output port

Tips

This tool shortens, expands, and retrieves statistics for URLs using a self-hosted YOURLS instance. It is ideal when you need to manage your own short links, offering more control than public services. The tool produces shortened URLs, original long URLs, or click statistics for specified short links.

Parameter Relationships

The YOURLS tool uses a conditional parameter system where the available parameters depend on the selected operation:

1. Base requirement: resource must be "url" (only option available)
2. Operation selection: operation determines which additional parameters are available
3. Operation-specific parameters:
   • "shorten" → requires url, optionally uses additionalFields
   • "expand" → requires shortUrl
   • "stats" → requires shortUrl

This hierarchical relationship ensures that only relevant parameters are presented based on the chosen operation type.