List Link Stats
yourls.list_stats
ActionBusiness appsconnection required
Calls the YOURLS API with the connection's credentials.
List short URLs ordered by clicks or by creation date.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- YOURLS
- Secret shape
- {"signature": "…"} or {"username": "…", "password": "…"}
- Config it needs
- base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
3 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
filter How to order the page: most clicked, least clicked, newest first, or a random selection. | string | No | top | one of "top", "bottom", "last", "rand" | — |
limit How many links to return in one page. | number | No | 10 | ≥ 1 | — |
start How many links to skip before the page begins, for paging. | number | No | 0 | ≥ 0 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"filter": "top",
"limit": 10,
"start": 0
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
links One entry per short URL, in the requested order. | array | — |
links[].shorturl The full short link YOURLS serves for this keyword. | string | — |
links[].url The long URL the short link redirects to. | string | — |
links[].title The page title YOURLS stored for the link. | string | — |
links[].timestamp When the link was created, as YOURLS stored it. | string | — |
links[].ip The IP address the link was created from. | string | — |
links[].clicks How many times the short link has been followed. | number | — |
count How many links this page carried. | number | — |
filter The ordering that was applied. | string | — |
stats The whole install's totals, which YOURLS adds here. | object | — |
stats.total_links How many short URLs the whole install holds. | number | — |
stats.total_clicks The sum of every short URL's click count. | number | — |
{
"count": 0,
"filter": "",
"links": [
{
"clicks": 0,
"ip": "",
"shorturl": "",
"timestamp": "",
"title": "",
"url": ""
}
],
"stats": {
"total_clicks": 0,
"total_links": 0
}
}Notes
- YOURLS returns this page as an object keyed link_1…link_N; the node flattens it to a list in that order.
Related YOURLS nodes
See List Link Stats run in a workflow.
In a technical demo we add the YOURLS connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.