Dub
Link management with Dub
Create, manage, and track short links with Dub. Supports custom domains, UTM parameters, link analytics, and more.
Create a new short link with Dub. Supports custom domains, slugs, UTM parameters, and more.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
url | string | Yes | No description |
domain | string | No | No description |
key | string | No | No description |
externalId | string | No | No description |
tagIds | string | No | No description |
comments | string | No | No description |
expiresAt | string | No | No description |
password | string | No | No description |
rewrite | boolean | No | No description |
archived | boolean | No | No description |
title | string | No | No description |
description | string | No | No description |
utm_source | string | No | No description |
utm_medium | string | No | No description |
utm_campaign | string | No | No description |
utm_term | string | No | No description |
utm_content | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | Unique ID of the created link |
domain | string | Domain of the short link |
key | string | Slug of the short link |
url | string | Destination URL |
shortLink | string | Full short link URL |
qrCode | string | QR code URL for the short link |
archived | boolean | Whether the link is archived |
externalId | string | External ID |
title | string | OG title |
description | string | OG description |
tags | json | Tags assigned to the link (id, name, color) |
clicks | number | Number of clicks |
leads | number | Number of leads |
sales | number | Number of sales |
saleAmount | number | Total sale amount in cents |
lastClicked | string | Last clicked timestamp |
createdAt | string | Creation timestamp |
updatedAt | string | Last update timestamp |
utm_source | string | utm_source output from the tool |
utm_medium | string | utm_medium output from the tool |
utm_campaign | string | utm_campaign output from the tool |
utm_term | string | utm_term output from the tool |
utm_content | string | utm_content output from the tool |
Create or update a short link by its URL. If a link with the same URL already exists, update it. Otherwise, create a new link.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
url | string | Yes | No description |
domain | string | No | No description |
key | string | No | No description |
externalId | string | No | No description |
tagIds | string | No | No description |
comments | string | No | No description |
expiresAt | string | No | No description |
password | string | No | No description |
rewrite | boolean | No | No description |
archived | boolean | No | No description |
title | string | No | No description |
description | string | No | No description |
utm_source | string | No | No description |
utm_medium | string | No | No description |
utm_campaign | string | No | No description |
utm_term | string | No | No description |
utm_content | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | Unique ID of the link |
domain | string | Domain of the short link |
key | string | Slug of the short link |
url | string | Destination URL |
shortLink | string | Full short link URL |
qrCode | string | QR code URL for the short link |
archived | boolean | Whether the link is archived |
externalId | string | External ID |
title | string | OG title |
description | string | OG description |
tags | json | Tags assigned to the link (id, name, color) |
clicks | number | Number of clicks |
leads | number | Number of leads |
sales | number | Number of sales |
saleAmount | number | Total sale amount in cents |
lastClicked | string | Last clicked timestamp |
createdAt | string | Creation timestamp |
updatedAt | string | Last update timestamp |
utm_source | string | utm_source output from the tool |
utm_medium | string | utm_medium output from the tool |
utm_campaign | string | utm_campaign output from the tool |
utm_term | string | utm_term output from the tool |
utm_content | string | utm_content output from the tool |
Retrieve information about a short link by its link ID, external ID, or domain + key combination.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
linkId | string | No | No description |
externalId | string | No | No description |
domain | string | No | No description |
key | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | Unique ID of the link |
domain | string | Domain of the short link |
key | string | Slug of the short link |
url | string | Destination URL |
shortLink | string | Full short link URL |
qrCode | string | QR code URL for the short link |
archived | boolean | Whether the link is archived |
externalId | string | External ID |
title | string | OG title |
description | string | OG description |
tags | json | Tags assigned to the link (id, name, color) |
clicks | number | Number of clicks |
leads | number | Number of leads |
sales | number | Number of sales |
saleAmount | number | Total sale amount in cents |
lastClicked | string | Last clicked timestamp |
createdAt | string | Creation timestamp |
updatedAt | string | Last update timestamp |
utm_source | string | UTM source parameter |
utm_medium | string | UTM medium parameter |
utm_campaign | string | UTM campaign parameter |
utm_term | string | UTM term parameter |
utm_content | string | UTM content parameter |
Update an existing short link. You can modify the destination URL, slug, metadata, UTM parameters, and more.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
linkId | string | Yes | No description |
url | string | No | No description |
domain | string | No | No description |
key | string | No | No description |
title | string | No | No description |
description | string | No | No description |
externalId | string | No | No description |
tagIds | string | No | No description |
comments | string | No | No description |
expiresAt | string | No | No description |
password | string | No | No description |
rewrite | boolean | No | No description |
archived | boolean | No | No description |
utm_source | string | No | No description |
utm_medium | string | No | No description |
utm_campaign | string | No | No description |
utm_term | string | No | No description |
utm_content | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | Unique ID of the updated link |
domain | string | Domain of the short link |
key | string | Slug of the short link |
url | string | Destination URL |
shortLink | string | Full short link URL |
qrCode | string | QR code URL for the short link |
archived | boolean | Whether the link is archived |
externalId | string | External ID |
title | string | OG title |
description | string | OG description |
tags | json | Tags assigned to the link (id, name, color) |
clicks | number | Number of clicks |
leads | number | Number of leads |
sales | number | Number of sales |
saleAmount | number | Total sale amount in cents |
lastClicked | string | Last clicked timestamp |
createdAt | string | Creation timestamp |
updatedAt | string | Last update timestamp |
utm_source | string | utm_source output from the tool |
utm_medium | string | utm_medium output from the tool |
utm_campaign | string | utm_campaign output from the tool |
utm_term | string | utm_term output from the tool |
utm_content | string | utm_content output from the tool |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
linkId | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | ID of the deleted link |
Retrieve a paginated list of short links for the authenticated workspace. Supports filtering by domain, search query, tags, and sorting.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
domain | string | No | No description |
search | string | No | No description |
tagIds | string | No | No description |
showArchived | boolean | No | No description |
sortBy | string | No | No description |
sortOrder | string | No | No description |
page | number | No | No description |
pageSize | number | No | No description |
| Parameter | Type | Description |
|---|
links | json | Array of link objects (id, domain, key, url, shortLink, clicks, tags, createdAt) |
count | number | Number of links returned |
Retrieve analytics for links including clicks, leads, and sales. Supports filtering by link, time range, and grouping by various dimensions.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
event | string | No | No description |
groupBy | string | No | Group results by: count (default), timeseries, countries, cities, devices, browsers, os, referers, top_links, top_urls |
linkId | string | No | No description |
externalId | string | No | No description |
domain | string | No | No description |
interval | string | No | No description |
start | string | No | No description |
end | string | No | No description |
country | string | No | No description |
timezone | string | No | No description |
| Parameter | Type | Description |
|---|
clicks | number | Total number of clicks |
leads | number | Total number of leads |
sales | number | Total number of sales |
saleAmount | number | Total sale amount in cents |
data | json | Grouped analytics data (timeseries, countries, devices, etc.) |
