Skip to content

Latest commit

 

History

History
106 lines (101 loc) · 43.3 KB

linkschema.md

File metadata and controls

106 lines (101 loc) · 43.3 KB

LinkSchema

Example Usage

import { LinkSchema } from "dub/models/components";

let value: LinkSchema = {
  id: "<id>",
  domain: "negligible-provider.name",
  key: "<key>",
  url: "https://insignificant-parsnip.info",
  externalId: "<id>",
  tenantId: "<id>",
  programId: "<id>",
  partnerId: "<id>",
  expiresAt: "1767443013408",
  expiredUrl: "https://ideal-scratch.name",
  password: "VxpjslLkzRHjLWz",
  title: "<value>",
  description: "cuckoo canter even along rim woot minus apropos",
  image: "https://picsum.photos/seed/GgJXf/2346/81",
  video: "https://picsum.videos/seed/XrQHiO/2305/2368",
  ios: "<value>",
  android: "<id>",
  geo: {},
  tagId: "<id>",
  tags: [
    {
      id: "<id>",
      name: "<value>",
      color: "green",
    },
  ],
  folderId: "<id>",
  webhookIds: [
    "<value>",
  ],
  comments:
    "proud plait opposite strict unnecessarily hamburger splosh around apologise lest ick yum following although trustworthy underplay hippodrome league given",
  shortLink: "https://wasteful-roundabout.net/",
  qrCode: "https://bouncy-marketplace.name",
  utmSource: "<value>",
  utmMedium: "<value>",
  utmCampaign: "<value>",
  utmTerm: "<value>",
  utmContent: "<value>",
  userId: "<id>",
  workspaceId: "<id>",
  lastClicked: "<value>",
  createdAt: "1738119684665",
  updatedAt: "1739258901248",
  projectId: "<id>",
};

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.
url string ✔️ The destination URL of the short link.
trackConversion boolean ➖ Whether to track conversions for the short link.
externalId string ✔️ The ID of the link in your database. If set, it can be used to identify the link in future API requests (must be prefixed with 'ext_' when passed as a query parameter). This key is unique across your workspace.
tenantId string ✔️ The ID of the tenant that created the link inside your system. If set, it can be used to fetch all links for a tenant.
programId string ✔️ The ID of the program the short link is associated with.
partnerId string ✔️ The ID of the partner the short link is associated with.
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.
video string ✔️ The custom link preview video (og:video). Will be used for Custom Social Media Cards if proxy is true. Learn more: https://d.to/og
rewrite boolean ➖ Whether the short link uses link cloaking.
doIndex boolean ➖ Whether to allow search engines to index the short link.
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.
folderId string ✔️ The unique ID of the folder assigned to the short link.
webhookIds string[] ✔️ The IDs of the webhooks that the short link is associated with.
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.
leads number ➖ The number of leads the short links has generated.
sales number ➖ The number of sales the short links has generated.
saleAmount number ➖ The total dollar amount of sales the short links has generated (in cents).
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.