List saved short links
List saved short links by status. Omit status for the active list. Use archived for the recoverable archive view, or all for both.
query Parameters
statusShort link status filter.
List saved short links › Responses
List of saved short links
idSavedShortLinkID of the saved short link.
savedShortLinkNameSaved short link display name.
slug^[a-z0-9_-]{1,64}$ · requiredOwner-scoped short-link slug.
idFunnelTarget funnel ID.
idTrafficSourceTarget traffic source ID.
statusfunnelNameTarget funnel name, resolved at read time rather than snapshotted — a rename is reflected without re-saving the link. Empty when the funnel no longer exists.
trafficSourceNameTarget traffic source name, resolved at read time. Empty when the traffic source no longer exists.
targetNodeIdOptional target entrance node ID for list and reporting projections.
targetNodeNameSnapshot of the target node name captured when the short link is saved.
trackingDomainPreferred tracking domain used to render this link. Display-only: the slug resolves on any of the owner's domains regardless of this value. Empty means fall back to the account default at render time.
Find saved short link by ID
Retrieve a saved short link by id.
query Parameters
idSavedShortLinkThe ID of the saved short link to retrieve.
Find saved short link by ID › Responses
The requested saved short link
idSavedShortLinkID of the saved short link.
savedShortLinkNameSaved short link display name.
slug^[a-z0-9_-]{1,64}$ · requiredLowercase owner-scoped slug used at /l/{slug}.
idFunnelTarget funnel ID.
idTrafficSourceTarget traffic source ID.
idNodeOptional target entrance node ID.
idPageOptional target entrance page ID. Requires idNode to be a page-group node containing the page.
targetNodeNameServer-managed snapshot of idNode's nodeName captured when the short link is saved.
Optional default query parameters. Visitor query values override these defaults key-by-key.
defaultCostOptional default value injected as query key c when the visitor request does not already include c.
trackingDomainPreferred tracking domain used to render this link. Display-only: the slug resolves on any of the owner's domains regardless of this value. Must be one of the owner's domains; absent means fall back to the account default at render time.
statusownerServer-managed owner context.
Find saved short link by slug
Retrieve an active saved short link by owner-scoped slug.
query Parameters
slug^[a-z0-9_-]{1,64}$ · requiredOwner-scoped short-link slug.
Find saved short link by slug › Responses
The requested saved short link
idSavedShortLinkID of the saved short link.
savedShortLinkNameSaved short link display name.
slug^[a-z0-9_-]{1,64}$ · requiredLowercase owner-scoped slug used at /l/{slug}.
idFunnelTarget funnel ID.
idTrafficSourceTarget traffic source ID.
idNodeOptional target entrance node ID.
idPageOptional target entrance page ID. Requires idNode to be a page-group node containing the page.
targetNodeNameServer-managed snapshot of idNode's nodeName captured when the short link is saved.
Optional default query parameters. Visitor query values override these defaults key-by-key.
defaultCostOptional default value injected as query key c when the visitor request does not already include c.
trackingDomainPreferred tracking domain used to render this link. Display-only: the slug resolves on any of the owner's domains regardless of this value. Must be one of the owner's domains; absent means fall back to the account default at render time.
statusownerServer-managed owner context.
Update a saved short link
Update an existing saved short link. Slugs remain owner-scoped and must be unique across all short links for the owner, including archived links.
Update a saved short link › Request Body
idSavedShortLinkID of the saved short link.
savedShortLinkNameSaved short link display name.
slug^[a-z0-9_-]{1,64}$ · requiredLowercase owner-scoped slug used at /l/{slug}.
idFunnelTarget funnel ID.
idTrafficSourceTarget traffic source ID.
idNodeOptional target entrance node ID.
idPageOptional target entrance page ID. Requires idNode to be a page-group node containing the page.
targetNodeNameServer-managed snapshot of idNode's nodeName captured when the short link is saved.
Optional default query parameters. Visitor query values override these defaults key-by-key.
defaultCostOptional default value injected as query key c when the visitor request does not already include c.
trackingDomainPreferred tracking domain used to render this link. Display-only: the slug resolves on any of the owner's domains regardless of this value. Must be one of the owner's domains; absent means fall back to the account default at render time.
statusownerServer-managed owner context.
Update a saved short link › Responses
Saved short link updated successfully
idSavedShortLinkID of the saved short link.
savedShortLinkNameSaved short link display name.
slug^[a-z0-9_-]{1,64}$ · requiredLowercase owner-scoped slug used at /l/{slug}.
idFunnelTarget funnel ID.
idTrafficSourceTarget traffic source ID.
idNodeOptional target entrance node ID.
idPageOptional target entrance page ID. Requires idNode to be a page-group node containing the page.
targetNodeNameServer-managed snapshot of idNode's nodeName captured when the short link is saved.
Optional default query parameters. Visitor query values override these defaults key-by-key.
defaultCostOptional default value injected as query key c when the visitor request does not already include c.
trackingDomainPreferred tracking domain used to render this link. Display-only: the slug resolves on any of the owner's domains regardless of this value. Must be one of the owner's domains; absent means fall back to the account default at render time.
statusownerServer-managed owner context.
Create a saved short link
Create a saved short link. The target must be a structured funnel entrance, not a generic URL.
Create a saved short link › Request Body
idSavedShortLinkID of the saved short link.
savedShortLinkNameSaved short link display name.
slug^[a-z0-9_-]{1,64}$ · requiredLowercase owner-scoped slug used at /l/{slug}.
idFunnelTarget funnel ID.
idTrafficSourceTarget traffic source ID.
idNodeOptional target entrance node ID.
idPageOptional target entrance page ID. Requires idNode to be a page-group node containing the page.
targetNodeNameServer-managed snapshot of idNode's nodeName captured when the short link is saved.
Optional default query parameters. Visitor query values override these defaults key-by-key.
defaultCostOptional default value injected as query key c when the visitor request does not already include c.
trackingDomainPreferred tracking domain used to render this link. Display-only: the slug resolves on any of the owner's domains regardless of this value. Must be one of the owner's domains; absent means fall back to the account default at render time.
statusownerServer-managed owner context.
Create a saved short link › Responses
Saved short link created successfully
idSavedShortLinkID of the saved short link.
savedShortLinkNameSaved short link display name.
slug^[a-z0-9_-]{1,64}$ · requiredLowercase owner-scoped slug used at /l/{slug}.
idFunnelTarget funnel ID.
idTrafficSourceTarget traffic source ID.
idNodeOptional target entrance node ID.
idPageOptional target entrance page ID. Requires idNode to be a page-group node containing the page.
targetNodeNameServer-managed snapshot of idNode's nodeName captured when the short link is saved.
Optional default query parameters. Visitor query values override these defaults key-by-key.
defaultCostOptional default value injected as query key c when the visitor request does not already include c.
trackingDomainPreferred tracking domain used to render this link. Display-only: the slug resolves on any of the owner's domains regardless of this value. Must be one of the owner's domains; absent means fall back to the account default at render time.
statusownerServer-managed owner context.
Delete saved short links
Permanently delete the specified saved short links. Unlike every other asset type, short links are hard-deleted: the row is removed and its slug is released back to the owner's slug namespace. This is not reversible — use /shortlink/archive/ for the reversible operation.
Delete saved short links › Responses
Saved short links deleted successfully
Duplicate a saved short link
Create a copy of an existing saved short link. Both a name and a slug are required: a slug is unique per owner and user-visible, so the server cannot derive one for the copy. The duplicate is always created active.
query Parameters
idSavedShortLinkID of the saved short link to duplicate.
Duplicate a saved short link › Request Body
nameName for the new saved short link
slug^[a-z0-9_-]{1,64}$ · requiredSlug for the new saved short link. Required, because slugs are unique per owner and user-visible — the server cannot derive one for a copy.
Duplicate a saved short link › Responses
Duplicated saved short link ID
idID of the newly created asset