Response schema for successful creation of short link that includes original link, meta data, hash of url, campaign attributes, document ID, document timestamps, redirect attributes and social media attributes of short link to be created.
Fields
id
StringKey used to uniquely identify document that contains shortlink details.
active
BooleanStatus of the shortlink.
app_redirect
BooleanApplication redirection flag of shortlink.
application
StringThe ID of the sales channel associated with the shortlink.
attribution
AttributionAdditional attributes of shortlink.
campaign
CampaignShortLinkCampaign attributes of shortlink.
count
IntClick count of shortlink.
created_at
StringThe timestamp indicating when a record was initially created.
created_by
StringReference of the creator of the shortlink.
enable_tracking
BooleanFlag to enable tracking of a short link.
expire_at
StringExpiry of the shortlink.
fallback
RedirectTypeFallback attributes of shortlink.
meta
JSONAdditional attributes of shortlink.
personalized
BooleanTo create personalized short links.
redirects
RedirectsRedirection attributes of shortlink.
social_media_tags
SocialMediaTagsSocial media attributes of shortlink.
title
StringName reference of the shortlink.
updated_at
StringThe timestamp indicating when a record was last modified or updated.
url
UrlInfoOriginal web address which will be converted to shortlink.
user_id
StringIdentifier which can uniquely identify the user.
Was this section helpful?