Link Object

The Link Object represents a single shortened URL created within a specified domain.

Each Link defines a mapping between a shortened path and a destination URL, along with configuration options for redirection behavior, lifetime, and tracking. The Shortener API automatically generates a unique short name (if not provided) and tracks usage statistics, such as hit counts and last access time.

A Link Object includes:

• destination_url — the target URL to which users are redirected.
• short_name — the short, unique path assigned within the domain.
• maximum_ttl — link lifetime in seconds (-1 for no expiration).
• mode — redirect behavior (proxy_pass, redirect_temporary, or redirect_permanent).
• hits and date_accessed — for access tracking and reporting.
• The generated url field — a complete short link combining the domain and short name.

This structure allows partners to manage large volumes of shortened URLs with granular control over expiration, redirection, and tracking.

Link Object Attributes

These fields and values make up the JSON object that gets returned with successful requests.

Attribute	Data Type	Description
date_accessed read only	string	The date and time when the link was accessed.
date_created read only	string	The date and time when the link was created.
destination_url createupdate	string	The site where the user will be sent.
hits read only	integer	The number of times that the link has been hit.
link_sid read only	string	The link secure ID.
maximum_ttl createupdate	integer	The link lifetime in seconds. Entering the -1 value means that the link will never expire. The default value is -1.
mode createupdate	string	The mode of the link. Values accepted in this field are: proxy_pass to serve the contents of the page directly. redirect_permanent to return the permanent redirect status code before redirect. redirect_temporary to return the temporary redirect status code before redirect. The default value is redirect_temporary.
partner_sid read only	string	The secure ID of the partner associated with the link.
short_name createupdate	string	The short portion of the URL. If there is no value in this field, it will be automatically generated. This value is unique to domain_sid.
url read only	string	The URL to get access to destination_url. This field value is generated automatically.

Sample Link Object

{
    "date_accessed": null,
    "date_created": "2024-01-18T19:26:02.553Z",
    "destination_url": "http://destinationurl.com",
    "link_sid": "330a8a83-d4bb-4f39-ae54-c59c8d87cd44",
    "hits": 0,
    "link_sid": "a533f53a-7e6f-4822-be3c-3767924ee2a9",
    "maximum_ttl": -1,
    "mode": "redirect_temporary",
    "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
    "short_name": "eOtEtO",
    "url": "http://newdomain.com/eOtEtO"
}