Dub

Dub integration (Marketing, Developer Tools). Imported from open-connector.

API key15 toolshttps://api.dub.co

POST

dub_create_link

Create a short link in the authenticated Dub workspace.

/links

38 parameters

Param	Type	Required	Description
url	string	required	The destination URL of the short link.
domain	string	optional	The short-link domain without protocol.
key	string	optional	The short-link slug.
keyLength	integer	optional	The length of the generated short-link slug.
externalId	string	optional	—
tenantId	string	optional	—
programId	string	optional	—
partnerId	string	optional	—
prefix	string	optional	The prefix used for randomly generated slugs.
trackConversion	boolean	optional	Whether Dub should track conversions for this link.
archived	boolean	optional	Whether the link should be archived.
tagIds	string	optional	The tag IDs assigned to the link.
tagNames	string	optional	The tag names assigned to the link.
folderId	string	optional	—
comments	string	optional	—
expiresAt	string	optional	—
expiredUrl	string	optional	—
password	string	optional	—
proxy	boolean	optional	Whether the link uses Dub custom link previews.
title	string	optional	—
description	string	optional	—
image	string	optional	—
video	string	optional	—
rewrite	boolean	optional	Whether the link uses link cloaking.
ios	string	optional	—
android	string	optional	—
geo	object	optional	—
doIndex	boolean	optional	Whether search engines may index the short link.
utm_source	string	optional	—
utm_medium	string	optional	—
utm_campaign	string	optional	—
utm_term	string	optional	—
utm_content	string	optional	—
ref	string	optional	—
webhookIds	array	optional	—
testVariants	array	optional	—
testStartedAt	string	optional	—
testCompletedAt	string	optional	—

GET

dub_list_links

List short links in the authenticated Dub workspace.

/links

13 parameters

Param	Type	Required	Description
domain	string	optional	Only return links for this domain.
tagIds	string	optional	Only return links with these tag IDs.
tagNames	string	optional	Only return links with these tag names.
folderId	string	optional	Only return links in this folder.
search	string	optional	Search against link slugs and destination URLs.
userId	string	optional	Only return links created by this Dub user ID.
tenantId	string	optional	Only return links for this tenant ID.
showArchived	boolean	optional	Whether archived links should be included.
sortBy	string	optional	The field used to sort links.
sortOrder	string	optional	The sort direction.
endingBefore	string	optional	Return links before this cursor.
startingAfter	string	optional	Return links after this cursor.
pageSize	integer	optional	The number of links to return.

GET

dub_retrieve_link

Retrieve a Dub short link by ID or by supported lookup fields.

/links/info

4 parameters

Param	Type	Required	Description
linkId	string	optional	The Dub link ID to retrieve.
domain	string	optional	The short-link domain used with key lookup.
key	string	optional	The short-link slug used with domain lookup.
externalId	string	optional	The external ID for the link. Prefix with ext_ when required by Dub.

PATCH

dub_update_link

Update a short link in the authenticated Dub workspace.

/links/{linkId}

39 parameters

Param	Type	Required	Description
linkId	string	required	The Dub link ID to update.
url	string	optional	The destination URL of the short link.
domain	string	optional	The short-link domain without protocol.
key	string	optional	The short-link slug.
keyLength	integer	optional	The length of the generated short-link slug.
externalId	string	optional	—
tenantId	string	optional	—
programId	string	optional	—
partnerId	string	optional	—
prefix	string	optional	The prefix used for randomly generated slugs.
trackConversion	boolean	optional	Whether Dub should track conversions for this link.
archived	boolean	optional	Whether the link should be archived.
tagIds	string	optional	The tag IDs assigned to the link.
tagNames	string	optional	The tag names assigned to the link.
folderId	string	optional	—
comments	string	optional	—
expiresAt	string	optional	—
expiredUrl	string	optional	—
password	string	optional	—
proxy	boolean	optional	Whether the link uses Dub custom link previews.
title	string	optional	—
description	string	optional	—
image	string	optional	—
video	string	optional	—
rewrite	boolean	optional	Whether the link uses link cloaking.
ios	string	optional	—
android	string	optional	—
geo	object	optional	—
doIndex	boolean	optional	Whether search engines may index the short link.
utm_source	string	optional	—
utm_medium	string	optional	—
utm_campaign	string	optional	—
utm_term	string	optional	—
utm_content	string	optional	—
ref	string	optional	—
webhookIds	array	optional	—
testVariants	array	optional	—
testStartedAt	string	optional	—
testCompletedAt	string	optional	—

DELETE

dub_delete_link

Delete a short link from the authenticated Dub workspace.

/links/{linkId}

1 parameter

Param	Type	Required	Description
linkId	string	required	The Dub link ID to delete.

GET

dub_count_links

Retrieve the number of matching links in the authenticated Dub workspace.

/links/count

8 parameters

Param	Type	Required	Description
domain	string	optional	Only count links for this domain.
tagIds	string	optional	Only count links with these tag IDs.
tagNames	string	optional	Only count links with these tag names.
folderId	string	optional	Only count links in this folder.
search	string	optional	Search against link slugs and destination URLs.
userId	string	optional	Only count links created by this Dub user ID.
tenantId	string	optional	Only count links for this tenant ID.
showArchived	boolean	optional	Whether archived links should be included.

GET

dub_list_tags

List tags in the authenticated Dub workspace.

/tags

2 parameters

Param	Type	Required	Description
page	integer	optional	The page number to retrieve.
pageSize	integer	optional	The number of tags to return.

POST

dub_create_tag

Create a tag in the authenticated Dub workspace.

/tags

2 parameters

Param	Type	Required	Description
name	string	required	The tag name.
color	string	optional	The Dub tag color.

PATCH

dub_update_tag

Update a tag in the authenticated Dub workspace.

/tags/{id}

3 parameters

Param	Type	Required	Description
id	string	required	The Dub tag ID to update.
name	string	optional	The updated tag name.
color	string	optional	The Dub tag color.

DELETE

dub_delete_tag

Delete a tag from the authenticated Dub workspace.

/tags/{id}

1 parameter

Param	Type	Required	Description
id	string	required	The Dub tag ID to delete.

GET

dub_list_folders

List folders in the authenticated Dub workspace.

/folders

2 parameters

Param	Type	Required	Description
page	integer	optional	The page number to retrieve.
pageSize	integer	optional	The number of folders to return.

POST

dub_create_folder

Create a folder in the authenticated Dub workspace.

/folders

1 parameter

Param	Type	Required	Description
name	string	optional	The folder name.

PATCH

dub_update_folder

Update a folder in the authenticated Dub workspace.

/folders/{id}

2 parameters

Param	Type	Required	Description
id	string	required	The Dub folder ID to update.
name	string	optional	The updated folder name.

DELETE

dub_delete_folder

Delete a folder from the authenticated Dub workspace.

/folders/{id}

1 parameter

Param	Type	Required	Description
id	string	required	The Dub folder ID to delete.

GET

dub_retrieve_analytics

Retrieve analytics for a Dub link, domain, or workspace.

/analytics

33 parameters

Param	Type	Required	Description
event	string	optional	The event metric to retrieve from Dub analytics.
groupBy	string	optional	The dimension used to group Dub analytics.
domain	string	optional	The domain filter for analytics.
key	string	optional	The link slug used with a domain filter.
linkId	string	optional	The Dub link ID filter.
externalId	string	optional	The external link ID filter.
tenantId	string	optional	The tenant ID filter.
tagId	string	optional	The tag ID filter.
folderId	string	optional	The folder ID filter.
partnerTagId	string	optional	The partner tag ID filter.
groupId	string	optional	The partner group ID filter.
partnerId	string	optional	The partner ID filter.
customerId	string	optional	The customer ID filter.
interval	string	optional	The analytics date range shortcut.
start	string	optional	The start timestamp for the analytics range.
end	string	optional	The end timestamp for the analytics range.
timezone	string	optional	The IANA time zone used to align timeseries buckets.
country	string	optional	The country filter using ISO 3166-1 alpha-2 codes.
city	string	optional	The city filter.
region	string	optional	The ISO 3166-2 region code filter.
continent	string	optional	The continent filter.
device	string	optional	The device filter.
browser	string	optional	The browser filter.
os	string	optional	The operating system filter.
trigger	string	optional	The trigger filter.
referer	string	optional	The referer hostname filter.
refererUrl	string	optional	The full referer URL filter.
url	string	optional	The destination URL filter.
utm_source	string	optional	The UTM source filter.
utm_medium	string	optional	The UTM medium filter.
utm_campaign	string	optional	The UTM campaign filter.
utm_term	string	optional	The UTM term filter.
utm_content	string	optional	The UTM content filter.