Share
The Sharing module simplifies the creation and sharing of QR codes and short links. Use it to generate QR codes for apps, products, collections, and URLs. Create short links for long URLs and retrieve them, along with the original URLs, using their respective codes.
QR Code & Short Link
You can utilize this to create a shortened URL from a long URL, product slug, or collection slug. Given the character limit of URLs in SMS communication (30 characters), employing this shortened URL facilitates easy sharing via SMS and email.
Operations
POST
# Create short link
GET
# Get short links
GET
# Get short link by hash
PATCH
# Update short link
GET
# Get short link click statistics
POST
Create short link
Generate a shortened URL link for sharing.
Parameters
body
object (ShortLinkReq)
ShortLinkReq
title
string
Give a name to the link.
url
string
The web address to shorten.
hash
string
Optional
active
boolean
Optional
expire_at
string
Optional
enable_tracking
boolean
Optional
personalized
boolean
Optional
To create personalized short links.
campaign
object (CampaignShortLink)
Optional
CampaignShortLink
redirects
object (Redirects)
Optional
Redirects
attribution
object (Attribution)
Optional
Attribution
social_media_tags
object (SocialMediaTags)
Optional
SocialMediaTags
count
integer
Optional
Response
200
4XX
Success
ShortLinkRes
title
string
Optional
url
object (UrlInfo)
Optional
UrlInfo
created_by
string
Optional
app_redirect
boolean
Optional
fallback
string
Optional
Enum
active
boolean
Optional
_id
string
Optional
enable_tracking
boolean
Optional
expire_at
string
Optional
application
string
Optional
user_id
string
Optional
created_at
string
Optional
meta
object
Optional
updated_at
string
Optional
personalized
boolean
Optional
To create personalized short links
campaign
object (CampaignShortLink)
Optional
CampaignShortLink
redirects
object (Redirects)
Optional
Redirects
attribution
object (Attribution)
Optional
Attribution
social_media_tags
object (SocialMediaTags)
Optional
SocialMediaTags
count
integer
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create short link
createShortLink
GET
Get short links
Retrieve a list of all generated short links.
Parameters
pageNo
integer
Optional
Current page number
Default Value : 1
pageSize
integer
Optional
Current page size
Default Value : 10
createdBy
string
Optional
Short link creator
Enum
active
string
Optional
Short link active status
Enum
shortUrl
string
Optional
Search for short url
originalUrl
string
Optional
Search for original url
title
string
Optional
Search text for title
Response
200
4XX
Success
ShortLinkList
items
array of object (ShortLinkRes)
Optional
Array of ShortLinkRes
page
object (Page)
Optional
Page
Examples
Parameters
pageNo:
0
pageSize:
0
createdBy:
"value"
active:
"value"
shortUrl:
"value"
originalUrl:
"value"
title:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get short links
getShortLinks
GET
Get short link by hash
Retrieve a specific short link by its unique hash.
Parameters
hash
string
Hash of short url
Response
200
4XX
Success
ShortLinkRes
title
string
Optional
url
object (UrlInfo)
Optional
UrlInfo
created_by
string
Optional
app_redirect
boolean
Optional
fallback
string
Optional
Enum
active
boolean
Optional
_id
string
Optional
enable_tracking
boolean
Optional
expire_at
string
Optional
application
string
Optional
user_id
string
Optional
created_at
string
Optional
meta
object
Optional
updated_at
string
Optional
personalized
boolean
Optional
To create personalized short links
campaign
object (CampaignShortLink)
Optional
CampaignShortLink
redirects
object (Redirects)
Optional
Redirects
attribution
object (Attribution)
Optional
Attribution
social_media_tags
object (SocialMediaTags)
Optional
SocialMediaTags
count
integer
Optional
Examples
Parameters
hash:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get short link by hash
getShortLinkByHash
PATCH
Update short link
Update details of a specific short link by its ID.
Parameters
id
string
Short link document identifier
body
object (ShortLinkReq)
ShortLinkReq
title
string
Give a name to the link.
url
string
The web address to shorten.
hash
string
Optional
active
boolean
Optional
expire_at
string
Optional
enable_tracking
boolean
Optional
personalized
boolean
Optional
To create personalized short links.
campaign
object (CampaignShortLink)
Optional
CampaignShortLink
redirects
object (Redirects)
Optional
Redirects
attribution
object (Attribution)
Optional
Attribution
social_media_tags
object (SocialMediaTags)
Optional
SocialMediaTags
count
integer
Optional
Response
200
4XX
Success
ShortLinkRes
title
string
Optional
url
object (UrlInfo)
Optional
UrlInfo
created_by
string
Optional
app_redirect
boolean
Optional
fallback
string
Optional
Enum
active
boolean
Optional
_id
string
Optional
enable_tracking
boolean
Optional
expire_at
string
Optional
application
string
Optional
user_id
string
Optional
created_at
string
Optional
meta
object
Optional
updated_at
string
Optional
personalized
boolean
Optional
To create personalized short links
campaign
object (CampaignShortLink)
Optional
CampaignShortLink
redirects
object (Redirects)
Optional
Redirects
attribution
object (Attribution)
Optional
Attribution
social_media_tags
object (SocialMediaTags)
Optional
SocialMediaTags
count
integer
Optional
Examples
Parameters
id:
"value"
body:
body
Was this section helpful?
PATCH
Loading...
Response
Loading...
Update short link
updateShortLinkById
GET
Get short link click statistics
Retrieve statistics and analytics for clicks on a short link.
Parameters
surlId
string
Short link ID for which click statistics are to be retrieved.
Response
200
4XX
Successful retrieval of click statistics.
ClickStatsResponse
click_stats
array of object (ClickStatsItem)
An array of click statistics for the short link.
Array of ClickStatsItem
Examples
Parameters
surlId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...