Help Center

GitHub

Dub.co Docs

API Reference

SDKs

Dashboard

Support

Everything you need to start using Dub.co

Quickstart

Dub is the link management platform for modern marketing teams.

Getting Started with Dub - Documentation

Introduction

A quick overview of how Dub is structured.

Data model

Integrate Dub.co with your favorite tools and services.

Dub.co Integrations: Connect Dub.co to tools and services

Integrations

Explore ideas and examples of what you can build with the Dub.co API

Dub.co API Examples - Build with the Dub.co API

Examples

A guide on how to run Dub.co's codebase locally.

How to setup Dub.co for Local Development (6 steps)

Local Development

An end-to-end guide on how to self-host Dub.co – the open-source link management platform.

How to self-host Dub.co in 8 easy steps

Self-hosting Dub.co

Dub.co API Reference - Introduction

What are Dub.co's API rate limits?

Rate limits

Troubleshoot problems with this comprehensive breakdown of all error codes.

Dub.co API returns machine readable error codes, human readable error messages and a link to the docs for more information

Errors

Create a new link for the authenticated workspace.

Create a new link with the Dub.co API - API Reference

Create a new link

Get link info with the Dub.co API - API Reference

Retrieve a link

Update a link for the authenticated workspace. If there's no change, returns it as it is.

Update a link with the Dub.co API - API Reference

Update a link

Upsert a link for the authenticated workspace by its URL. If a link with the same URL already exists, return it (or update it if there are any changes). Otherwise, a new link will be created.

Upsert a link with the Dub.co API - API Reference

Upsert a link

Delete a link for the authenticated workspace.

Delete a link with the Dub.co API - API Reference

Delete a link

Retrieve a list of links for the authenticated workspace. The list will be paginated and the provided query parameters allow filtering the returned links.

Get list of links with the Dub.co API - API Reference

Retrieve a list of links

Retrieve the number of links for the authenticated workspace. The provided query parameters allow filtering the returned links.

Get the links count with the Dub.co API - API Reference

Retrieve the number of links

Bulk create up to 100 links for the authenticated workspace.

Bulk create links with the Dub.co API - API Reference

Bulk create links

Retrieve the total number of clicks for a link, a domain, or the authenticated workspace.

Clicks – Count

Retrieve the total clicks count

Retrieve timeseries click analytics for a link, a domain, or the authenticated workspace over a period of time.

Clicks – Timeseries

Retrieve timeseries click analytics

Retrieve the top browsers by number of clicks for a link, a domain, or the authenticated workspace.

Clicks – Browsers

Retrieve top browsers by clicks

Retrieve the top countries by number of clicks for a link, a domain, or the authenticated workspace.

Clicks – Cities

Retrieve top cities by clicks

Clicks – Countries

Retrieve top countries by clicks

Retrieve the top devices by number of clicks for a link, a domain, or the authenticated workspace.

Clicks – Devices

Retrieve top devices by clicks

Retrieve the top OS by number of clicks for a link, a domain, or the authenticated workspace.

Clicks – OS

Retrieve top OS by clicks

Retrieve the top referers by number of clicks for a link, a domain, or the authenticated workspace.

Clicks – Referers

Retrieve top referers by clicks

Retrieve the top links by number of clicks for a domain or the authenticated workspace.

Clicks – Top Links

Retrieve top links by clicks

Retrieve the top URLs by number of clicks for a given short link.

Clicks – Top URLs

Retrieve top URLs by clicks

Get a QR code with the Dub.co API - API Reference

Retrieve a QR code

Create a new workspace for the authenticated user.

Create a new workspace with the Dub.co API - API Reference

Create a workspace

Retrieve a workspace for the authenticated user.

Get workspace info with the Dub.co API - API Reference

Retrieve a workspace

Retrieve a list of workspaces for the authenticated user.

Get list of workspaces with the Dub.co API - API Reference

Retrieve a list of workspaces

Add a domain to the authenticated workspace.

Add a domain to the workspace with the Dub.co API - API Reference

Add a domain

Update a domain for the authenticated workspace.

Update a domain with the Dub.co API - API Reference

Update a domain

Delete a domain from a workspace. It cannot be undone. This will also delete all the links associated with the domain.

Delete a domain from the workspace with the Dub.co API - API Reference

Delete a domain

Retrieve a list of domains associated with the authenticated workspace.

Get list of domains associated with the workspace with the Dub.co API - API Reference

Retrieve a list of domains

Set a domain as primary for the authenticated workspace.

Set a domain as primary for a workspace with the Dub.co API - API Reference

Set a domain as primary

Transfer a domain to another workspace within the authenticated account.

Transfer a domain to the another workspace with the Dub.co API - API Reference

Transfer a domain

Create a new tag for the authenticated workspace.

Create a new tag with the Dub.co API - API Reference

Create a new tag

Retrieve a list of tags for the authenticated workspace.

Get list of tags with the Dub.co API - API Reference

Retrieve a list of tags

Retrieve the metatags for a URL

Open-source client libraries for the Dub.co API

Open-source libraries & SDKs for Dub.co API

Overview

dub.links.create - Create a new link - TypeScript SDK

Create

Retrieve info for a link by specifying either the domain and key or the linkId or externalId

dub.links.get - Retrieve a link - TypeScript SDK

Edit a link for the authenticated workspace. Support partial updates.

dub.links.update - Edit a link - TypeScript SDK

Update

dub.links.upsert - Upsert a new link - TypeScript SDK

Upsert

dub.links.delete - Delete a link - TypeScript SDK

Delete

dub.links.list - Retrieve a list of links - TypeScript SDK

List

dub.links.count - Retrieve the number of links - TypeScript SDK

Count

dub.links.createMany - Bulk create links - TypeScript SDK

Create Many

dub.workspaces.create - Create a workspace - TypeScript SDK

dub.workspaces.create

dub.workspaces.get - Retrieve a workspace - TypeScript SDK

dub.workspaces.get

dub.workspaces.list - Retrieve a list of workspaces - TypeScript SDK

dub.workspaces.list

dub.domains.add - Add a domain - TypeScript SDK

Edit a domain for the authenticated workspace.

Getting Started

Resources

Open source

Quickstart