dub-node/docs/models/components/linkschema.md

LinkSchema

Fields

Field	Type	Required	Description
id	string	✔️	The unique ID of the short link.
domain	string	✔️	The domain of the short link. If not provided, the primary domain for the workspace will be used (or dub.sh if the workspace has no domains).
key	string	✔️	The short link slug. If not provided, a random 7-character slug will be generated.
externalId	string	✔️	This is the ID of the link in your database. If set, it can be used to identify the link in the future. Must be prefixed with 'ext_' when passed as a query parameter.
url	string	✔️	The destination URL of the short link.
trackConversion	boolean	➖	[BETA] Whether to track conversions for the short link.
archived	boolean	➖	Whether the short link is archived.
expiresAt	string	✔️	The date and time when the short link will expire in ISO-8601 format.
expiredUrl	string	✔️	The URL to redirect to when the short link has expired.
password	string	✔️	The password required to access the destination URL of the short link.
proxy	boolean	➖	Whether the short link uses Custom Social Media Cards feature.
title	string	✔️	The title of the short link generated via api.dub.co/metatags. Will be used for Custom Social Media Cards if proxy is true.
description	string	✔️	The description of the short link generated via api.dub.co/metatags. Will be used for Custom Social Media Cards if proxy is true.
image	string	✔️	The image of the short link generated via api.dub.co/metatags. Will be used for Custom Social Media Cards if proxy is true.
rewrite	boolean	➖	Whether the short link uses link cloaking.
ios	string	✔️	The iOS destination URL for the short link for iOS device targeting.
android	string	✔️	The Android destination URL for the short link for Android device targeting.
geo	components.Geo	✔️	Geo targeting information for the short link in JSON format {[COUNTRY]: https://example.com }. Learn more: https://d.to/geo
publicStats	boolean	➖	Whether the short link's stats are publicly accessible.
tagId	string	✔️	: warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. The unique ID of the tag assigned to the short link. This field is deprecated – use tags instead.
tags	components.TagSchema[]	✔️	The tags assigned to the short link.
comments	string	✔️	The comments for the short link.
shortLink	string	✔️	The full URL of the short link, including the https protocol (e.g. https://dub.sh/try).
qrCode	string	✔️	The full URL of the QR code for the short link (e.g. https://api.dub.co/qr?url=https://dub.sh/try).
utmSource	string	✔️	The UTM source of the short link.
utmMedium	string	✔️	The UTM medium of the short link.
utmCampaign	string	✔️	The UTM campaign of the short link.
utmTerm	string	✔️	The UTM term of the short link.
utmContent	string	✔️	The UTM content of the short link.
userId	string	✔️	The user ID of the creator of the short link.
workspaceId	string	✔️	The workspace ID of the short link.
clicks	number	➖	The number of clicks on the short link.
lastClicked	string	✔️	The date and time when the short link was last clicked.
createdAt	string	✔️	The date and time when the short link was created.
updatedAt	string	✔️	The date and time when the short link was last updated.
projectId	string	✔️	: warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. The project ID of the short link. This field is deprecated – use workspaceId instead.