| title | description | icon |
|---|---|---|
Data model |
A quick overview of how Dub is structured. |
database |
import WorkspaceResponse from "/snippets/workspace-response.mdx"; import LinkResponse from "/snippets/link-response.mdx"; import DomainResponse from "/snippets/domain-response.mdx"; import TagResponse from "/snippets/tag-response.mdx";
Whether you are using Dub's API or not, this page is a quick way to understand how Dub works.
Within Dub, all data belongs to a Workspace. Within a workspace, you have Links, Domains, Tags, and more.
Workspaces is the defacto way of organizing your links and working with your team on Dub. You can think of a Dub workspace like a workspace on Slack or Discord – it's a shared space where you can invite your team members to collaborate on links.
When interacting with Dub's API, you'll also need to create a workspace API key to authenticate your requests.
Links are the bread and butter of Dub. You can shorten any URL to a Dub link, which you can then share with your audience. Links can be created, updated, and deleted via the Dub API or the Dub dashboard.
On Dub, you can add custom domains to create branded short links for better brand recognition. You can also set a primary domain for it to be used as the default domain for new links (both via the API and the dashboard).
Tags are a way to organize your links. You can add tags to your links to categorize them and make them easier to find. You can also filter analytics by tags to get a better understanding of how your campaigns are performing.