Dub

使用说明

Create, manage, and track short links with Dub. Supports custom domains, UTM parameters, link analytics, and more.

工具

`dub_create_link`

Create a new short link with Dub. Supports custom domains, slugs, UTM parameters, and more.

输入

参数	类型	必填	描述
`apiKey`	string	是	Dub API key
`url`	string	是	The destination URL of the short link
`domain`	string	否	Custom domain for the short link (defaults to dub.sh)
`key`	string	否	Custom slug for the short link (randomly generated if not provided)
`externalId`	string	否	External ID for the link in your database
`tagIds`	string	否	Comma-separated tag IDs to assign to the link
`comments`	string	否	Comments for the short link
`expiresAt`	string	否	Expiration date in ISO 8601 format
`password`	string	否	Password to protect the short link
`rewrite`	boolean	否	Whether to enable link cloaking
`archived`	boolean	否	Whether to archive the link
`title`	string	否	Custom OG title for the link preview
`description`	string	否	Custom OG description for the link preview
`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

输出

参数	类型	描述
`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 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

`dub_upsert_link`

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.

输入

参数	类型	必填	描述
`apiKey`	string	是	Dub API key
`url`	string	是	The destination URL of the short link
`domain`	string	否	Custom domain for the short link (defaults to dub.sh)
`key`	string	否	Custom slug for the short link (randomly generated if not provided)
`externalId`	string	否	External ID for the link in your database
`tagIds`	string	否	Comma-separated tag IDs to assign to the link
`comments`	string	否	Comments for the short link
`expiresAt`	string	否	Expiration date in ISO 8601 format
`password`	string	否	Password to protect the short link
`rewrite`	boolean	否	Whether to enable link cloaking
`archived`	boolean	否	Whether to archive the link
`title`	string	否	Custom OG title for the link preview
`description`	string	否	Custom OG description for the link preview
`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

输出

参数	类型	描述
`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

`dub_get_link`

Retrieve information about a short link by its link ID, external ID, or domain + key combination.

输入

参数	类型	必填	描述
`apiKey`	string	是	Dub API key
`linkId`	string	否	The unique ID of the short link
`externalId`	string	否	The external ID of the link in your database
`domain`	string	否	The domain of the link (use with key)
`key`	string	否	The slug of the link (use with domain)

输出

参数	类型	描述
`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

`dub_update_link`

Update an existing short link. You can modify the destination URL, slug, metadata, UTM parameters, and more.

输入

参数	类型	必填	描述
`apiKey`	string	是	Dub API key
`linkId`	string	是	The link ID or external ID prefixed with ext_
`url`	string	否	New destination URL
`domain`	string	否	New custom domain
`key`	string	否	New custom slug
`title`	string	否	Custom OG title
`description`	string	否	Custom OG description
`externalId`	string	否	External ID for the link
`tagIds`	string	否	Comma-separated tag IDs
`comments`	string	否	Comments for the short link
`expiresAt`	string	否	Expiration date in ISO 8601 format
`password`	string	否	Password to protect the link
`rewrite`	boolean	否	Whether to enable link cloaking
`archived`	boolean	否	Whether to archive the link
`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

输出

参数	类型	描述
`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 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

`dub_delete_link`

Delete a short link by its link ID or external ID (prefixed with ext_).

输入

参数	类型	必填	描述
`apiKey`	string	是	Dub API key
`linkId`	string	是	The link ID or external ID prefixed with ext_

输出

参数	类型	描述
`id`	string	ID of the deleted link

`dub_list_links`

Retrieve a paginated list of short links for the authenticated workspace. Supports filtering by domain, search query, tags, and sorting.

输入

参数	类型	必填	描述
`apiKey`	string	是	Dub API key
`domain`	string	否	Filter by domain
`search`	string	否	Search query matched against the short link slug and destination URL
`tagIds`	string	否	Comma-separated tag IDs to filter by
`showArchived`	boolean	否	Whether to include archived links (defaults to false)
`page`	number	否	Page number (default: 1)
`pageSize`	number	否	Number of links per page (default: 100, max: 100)

输出

参数	类型	描述
`links`	json	Array of link objects (id, domain, key, url, shortLink, clicks, tags, createdAt)
`count`	number	Number of links returned

`dub_get_links_count`

Retrieve the number of short links for the authenticated workspace, optionally filtered and grouped by domain, tag, user, or folder.

输入

参数	类型	必填	描述
`apiKey`	string	是	Dub API key
`domain`	string	否	Filter by domain
`search`	string	否	Search query matched against the short link slug and destination URL
`tagIds`	string	否	Comma-separated tag IDs to filter by
`tagNames`	string	否	Comma-separated tag names to filter by (case-insensitive)
`folderId`	string	否	Filter by folder ID
`showArchived`	boolean	否	Whether to include archived links (defaults to false)
`groupBy`	string	否	Group counts by: domain, tagId, userId, or folderId

输出

参数	类型	描述
`count`	number	Total number of links matching the filters
`groups`	json	Per-group counts when groupBy is set (e.g. [{ domain, count }])

`dub_bulk_create_links`

Create up to 100 short links in a single request. Returns the created links alongside any per-link errors.

输入

参数	类型	必填	描述
`apiKey`	string	是	Dub API key
`links`	json	是	JSON array of link objects to create. Each object requires a "url" and may include domain, key, tagIds, and other link fields (max 100).

输出

参数	类型	描述
`created`	json	Array of successfully created link objects
`errors`	json	Array of per-link errors ({ link, error, code }) for links that failed
`count`	number	Number of links successfully created

`dub_bulk_update_links`

Apply the same set of field updates to up to 100 links at once, selected by link IDs or external IDs.

输入

参数	类型	必填	描述
`apiKey`	string	是	Dub API key
`linkIds`	string	否	Comma-separated link IDs to update (max 100, takes precedence over externalIds)
`externalIds`	string	否	Comma-separated external IDs to update (max 100)
`data`	json	是	JSON object of fields to apply to every selected link (e.g. { "archived": true, "tagIds": ["..."] })

输出

参数	类型	描述
`updated`	json	Array of updated link objects
`count`	number	Number of links updated

`dub_bulk_delete_links`

Delete up to 100 short links in a single request by their link IDs. Non-existing IDs are ignored.

输入

参数	类型	必填	描述
`apiKey`	string	是	Dub API key
`linkIds`	string	是	Comma-separated link IDs to delete (max 100)

输出

参数	类型	描述
`deletedCount`	number	Number of links that were deleted

`dub_get_analytics`

Retrieve analytics for links including clicks, leads, and sales. Supports filtering by link, time range, and grouping by various dimensions.

输入

参数	类型	必填	描述
`apiKey`	string	是	Dub API key
`event`	string	否	Event type: clicks (default), leads, sales, or composite
`groupBy`	string	否	Group results by: count (default), timeseries, countries, cities, devices, browsers, os, referers, top_links, top_urls
`linkId`	string	否	Filter by link ID
`externalId`	string	否	Filter by external ID (prefix with ext_)
`domain`	string	否	Filter by domain
`interval`	string	否	Time interval: 24h (default), 7d, 30d, 90d, 1y, mtd, qtd, ytd, or all
`start`	string	否	Start date/time in ISO 8601 format (overrides interval)
`end`	string	否	End date/time in ISO 8601 format (defaults to now)
`country`	string	否	Filter by country (ISO 3166-1 alpha-2 code)
`timezone`	string	否	IANA timezone for timeseries data (defaults to UTC)

输出

参数	类型	描述
`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.)

`dub_get_events`

Retrieve a paginated stream of individual click, lead, and sale events for links, with filtering by link, time range, and location.

输入

参数	类型	必填	描述
`apiKey`	string	是	Dub API key
`event`	string	否	Event type: clicks (default), leads, or sales
`linkId`	string	否	Filter by link ID
`externalId`	string	否	Filter by external ID (prefix with ext_)
`domain`	string	否	Filter by domain
`interval`	string	否	Time interval: 24h (default), 7d, 30d, 90d, 1y, mtd, qtd, ytd, or all
`start`	string	否	Start date/time in ISO 8601 format (overrides interval)
`end`	string	否	End date/time in ISO 8601 format (defaults to now)
`country`	string	否	Filter by country (ISO 3166-1 alpha-2 code)
`timezone`	string	否	IANA timezone for event timestamps (defaults to UTC)
`page`	number	否	Page number (default: 1)
`limit`	number	否	Number of events per page (default: 100, max: 1000)
`sortOrder`	string	否	Sort order: desc (default) or asc

输出

参数	类型	描述
`events`	json	Array of event objects (event, timestamp, click, link, and customer/sale data when applicable)
`count`	number	Number of events returned

`dub_get_qr_code`

Generate a customizable QR code (PNG) for a short link, with control over size, error correction, colors, and margin.

输入

参数	类型	必填	描述
`apiKey`	string	是	Dub API key
`url`	string	是	The short link URL to encode in the QR code
`size`	number	否	QR code size in pixels (default: 600)
`level`	string	否	Error correction level: L (default), M, Q, or H
`fgColor`	string	否	Foreground color in hex (default: #000000)
`bgColor`	string	否	Background color in hex (default: #FFFFFF)
`hideLogo`	boolean	否	Whether to hide the logo in the center of the QR code (default: false)
`margin`	number	否	Margin (quiet zone) around the QR code (default: 2)

输出

参数	类型	描述
`file`	file	Generated QR code image stored in execution files
`content`	string	Base64-encoded PNG image data

On this page