Dub

Docs

• Introduction
• Retrieve analytics: Retrieve analytics for a link, a domain, or the authenticated workspace. The response type depends on the event and type query parameters.
• API Authentication
• Approve a bounty submission: Approve a bounty submission. Optionally specify a custom reward amount.
• List bounty submissions: List all submissions for a specific bounty in your partner program.
• Reject a bounty submission: Reject a bounty submission with a specified reason and optional note.
• Create commission: Create one or more commissions (custom, lead or sale) for a partner. Commission creation is processed asynchronously. Use the List Commissions endpoint or webhooks to be notified when the commission is created.
• List all commissions: Retrieve a paginated list of commissions for your partner program.
• Update a commission: Update an existing commission amount. This is useful for handling refunds (partial or full) or fraudulent sales.
• Delete a customer: Delete a customer from a workspace.
• List all customers: Retrieve a paginated list of customers for the authenticated workspace.
• Retrieve a customer: Retrieve a customer by ID for the authenticated workspace. To retrieve a customer by external ID, prefix the ID with ext_.
• Update a customer: Update a customer for the authenticated workspace.
• Check the availability of one or more domains: Check if a domain name is available for purchase. You can check multiple domains at once.
• Create a domain: Create a domain for the authenticated workspace.
• Delete a domain: Delete a domain from a workspace. It cannot be undone. This will also delete all the links associated with the domain.
• Register a domain: Register a domain for the authenticated workspace. Only available for Enterprise Plans.
• Update a domain: Update a domain for the authenticated workspace.
• List all events: Retrieve a paginated list of events for the authenticated workspace.
• Create a folder: Create a folder for the authenticated workspace.
• Delete a folder: Delete a folder from the workspace. All existing links will still work, but they will no longer be associated with this folder.
• List all folders: Retrieve a paginated list of folders for the authenticated workspace.
• Update a folder: Update a folder in the workspace.
• Introduction: Learn how to use Dub's API to programmatically manage resources in your Dub workspace.
• Bulk create links: Bulk create up to 100 links for the authenticated workspace.
• Bulk delete links: Bulk delete up to 100 links for the authenticated workspace.
• Bulk update links: Bulk update up to 100 links with the same data for the authenticated workspace.
• Retrieve links count: Retrieve the number of links for the authenticated workspace.
• Create a link: Create a link for the authenticated workspace.
• Delete a link: Delete a link for the authenticated workspace.
• List all links: Retrieve a paginated list of links for the authenticated workspace.
• Retrieve a link: Retrieve the info for a link.
• Update a link: Update a link for the authenticated workspace. If there's no change, returns it as it is.
• Upsert 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.
• Approve a partner application: Approve a pending partner application to your program. The partner will be enrolled in the specified group and notified of the approval.
• List all pending partner applications: Retrieve a paginated list of pending applications for your partner program.
• Reject a partner application: Reject a pending partner application to your program. The partner will be notified via email that their application was not approved.
• Ban a partner: Ban a partner from your program. This will disable all links and mark all commissions as canceled.
• Create or update a partner: Creates or updates a partner record (upsert behavior). If a partner with the same email already exists, their program enrollment will be updated with the provided tenantId. If no existing partner is found, a new partner will be created using the supplied information.
• Create a link for a partner: Create a link for a partner that is enrolled in your program.
• Deactivate a partner: This will deactivate the partner from your program and disable all their active links. Their commissions and payouts will remain intact. You can reactivate them later if needed.
• List all partners: List all partners for a partner program.
• Retrieve a partner's links.: Retrieve a partner's links by their partner ID or tenant ID.
• Upsert a link for a partner: Upsert a link for a partner that is enrolled in your program. 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.
• List all payouts: Retrieve a paginated list of payouts for your partner program.
• Rate limits: Learn about Dub's API rate limits.
• Create a tag: Create a tag for the authenticated workspace.
• List all tags: Retrieve a paginated list of tags for the authenticated workspace.
• Update a tag: Update a tag in the workspace.
• Track a lead event: Track a lead for a short link.
• Track a deep link open event: This endpoint is used to track when a user opens your app via a Dub-powered deep link (for both iOS and Android).
• Track a sale event: Track a sale for a short link.
• Device data
• Introduction: Learn how to use Dub's Analytics API to build real-time analytics dashboards for your links.
• Links data: Learn how to retrieve analytics data on Dub by links, folders, and tags
• Location data
• Partners data: Learn how to retrieve analytics data on Dub by partners, partner groups, and partner tags
• Referrers data
• UTM data
• How attribution works: A deep-dive into Dub's attribution infrastructure and how conversion tracking works from click → lead → sale → commission.
• Deep link attribution: Learn how to use deep link attribution to track conversions events with Dub.
• Deferred deep linking: Learn how to use deferred deep linking to track conversions and traffic.
• Migrating from Firebase Dynamic Links: Learn how to migrate from Firebase Dynamic Links to Dub.
• Quickstart: Learn how to use Dub to create deep links for your mobile app (with native support for React Native, iOS, and Android).
• Bulk operations: Learn how to perform bulk operations on links.
• Introduction: Learn how to use Dub to programmatically create, update, and delete links at scale.
• Organizing links: Learn how to associate links with users, campaigns, teams, and other entities within your system.
• Appwrite: Learn how to track lead conversion events with Appwrite and Dub
• Auth0: Learn how to track lead conversion events with Auth0 and Dub
• Better Auth: Learn how to track lead conversion events with Better Auth and Dub
• Clerk: Learn how to track lead conversion events with Clerk and Dub
• Deferred lead tracking: Learn how to track a deferred lead conversion event with Dub
• NextAuth.js: Learn how to track lead conversion events with NextAuth.js and Dub
• Supabase: Learn how to track lead conversion events with Supabase and Dub
• Direct sale tracking: Learn how to track sales without a prior lead event using Dub
• Tracking refunds: Learn how to track refund events for your Dub partner program
• Introduction: Integrate Dub with your favorite tools and services.
• Google Tag Manager: Learn how to track sales conversion events with Google Tag Manager and Dub
• HubSpot: Learn how to track lead conversion events with HubSpot and Dub
• Build your own integration: Learn how to authenticate users with OAuth 2.0. for your Dub integration.
• Segment: Learn how to track sale conversion events with Segment and Dub
• Shopify: Learn how to track sale conversion events with Shopify and Dub
• Stripe: Learn how to track sale conversion events with Stripe and Dub
• Local development: A guide on how to run Dub's codebase locally.
• Dub MCP Server: Use the Dub MCP server to manage your partner program with the AI agent of your choice.
• Introduction: Learn how to use Dub's Partner API to programmatically manage your partner account.
• Embedded referral dashboard: Learn how to create an embedded referral dashboard with Dub for your users to join your partner program without leaving your app.
• Event types: List of supported postback event types and their payloads
• commission.created
• lead.created
• sale.created
• Introduction: Use postbacks to get real-time notifications on events happening across your Dub partner account.
• Verify postback requests: Learn how to verify postback requests to ensure they're coming from Dub.
• Client-side tracking: Learn how to track sales conversion events with Dub on the client-side
• Server-side tracking: Learn how to track conversion events with Dub using server-side tracking.
• React Native: How to add the Dub React Native SDK to your React Native project
• Swift: How to add the Dub iOS SDK to your Swift project
• Introduction: Learn more about the the Dub client-side mobile SDKs.
• Client-side click tracking: Track clicks on the client-side using query parameters
• Client-side conversion tracking: Learn how to use the Dub Analytics script to track conversion events on the client-side
• Cross-domain tracking: Track conversions across domains
• Reverse-proxy support: Track clicks on the client-side using a reverse proxy
• Framer: How to add the Dub Analytics script to your Framer site
• Google Tag Manager: How to add the Dub Analytics script to your site using Google Tag Manager
• Manual Installation: How to add the Dub Analytics script to your website
• React: How to add the Dub Analytics script to your React website
• Shopify: How to add the Dub Analytics script to your Shopify store
• Webflow: How to add the Dub Analytics script to your Webflow site
• WordPress: How to add the Dub Analytics script to your WordPress site
• Introduction: Learn more about the Dub Analytics script and how to install it.
• Script Variants: Learn more about the different variants of the Dub Analytics script.
• Go SDK: Learn how to integrate Dub with Go.
• Overview: Open-source client libraries for the Dub API
• PHP SDK: Learn how to integrate Dub with PHP.
• Python SDK: Learn how to integrate Dub with Python.
• Ruby SDK: Learn how to integrate Dub with Ruby.
• TypeScript SDK: Learn how to integrate Dub with TypeScript.
• Self-hosting Dub: An end-to-end guide on how to self-host Dub – the open-source link attribution platform.
• Event types: List of supported webhook event types and their payloads
• commission.created
• lead.created
• link.clicked
• link.created
• link.deleted
• link.updated
• partner.application_submitted
• partner.enrolled
• sale.created
• Introduction: Use webhooks to get real-time notifications on events happening across your Dub workspace.
• Verify webhook requests: Learn how to verify webhook requests to ensure they're coming from Dub.
• Dub Help Center: Find answers to all your Dub-related questions.
• How to run A/B tests with Dub Links?: Run A/B tests to compare different short-link variations and identify what drives the highest conversions.
• Application analytics: Use application analytics to understand where partner applications come from and how applicants move from visit to approval.
• Archiving domains on Dub: Learn more about how you can archive domains on Dub to better manage your domains.
• Configuring SAML SSO with Azure AD: For Dub Enterprise users, you can securely manage your team's access to Dub using Azure AD SAML SSO.
• Configuring SCIM Directory Sync with Azure AD: For Dub Enterprise users, you can automatically provision and deprovision users from Azure AD to Dub using SCIM Directory Sync.
• How to manage your links in bulk: Learn how to speed up your link management workflow with bulk link actions.
• How to choose a custom domain for your short links: Learn how to choose the right custom domain for your short links on Dub.
• Commission analytics: Use commission analytics to understand how much your partners are earning over time and which commissions are driving your program payouts.
• How commissions and payouts work on Dub: Learn about the different commission and payout statuses on Dub and when you can expect to be paid by the programs you work with.
• Communicating with your programs: Learn about using the messaging center to stay connected with your programs, view conversations, and send messages.
• How to set custom link previews for your Dub links?: Learn how to customize how your links show up on social media to improve click-through rates.
• Custom QR codes: Learn how custom QR codes work on Dub.
• Customer insights: Get deeper, real-time insights about your customers' demographics, purchasing behavior, and lifetime value (LTV).
• What are default Dub domains?: Learn more about the default branded domains provided by Dub and how you can use them to share your links.
• How to use device targeting on Dub?: Learn how to use device targeting on Dub to personalize the destination URL for your links based on the user's device type.
• Offering dual-sided incentives: Learn how to offer dual-sided incentives to your partners and the users they refer.
• Dub Analytics Overview: Learn about how you can use Dub Analytics to better understand your audience.
• Dub Analytics Limits: Learn about the different limits for Dub Analytics and how many clicks you can track on each plan.
• Conversion tracking: Learn how you can use Dub to track how your link clicks are converting to signups and sales.
• What is the Dub link builder?: Learn more about the Dub link builder, how to open it (with various shortcuts), and how to use it to create a short link.
• Dub Links Overview: Learn more about Dub Links, what it can do for your business and what makes it different to other solutions.
• Why are my dub.sh links not working?: Our default dub.sh links are occasionally blocked by certain web browsers and ISPs, which causes them not to work. Learn more about why, and how to fix it.
• Dub Partners Overview: Learn how you can use Dub to recruit, manage, and pay out your affiliates, publishers, influencers, UGC creators, user referrals, and more.
• Sending marketing and transactional emails to your partners: Learn how to craft and send marketing and transactional emails to your partners to increase partner engagement and drive conversions.
• How to filter analytics by folders: Learn how to create powerful campaign-specific reports for your links with our folders feature.
• How to filter analytics by tags: Learn how to create powerful campaign-specific reports for your links with our tags feature.
• How to filter by trigger type: Learn how to filter between QR code scans, link clicks, and deep links in your Dub analytics.
• Filtering and visualizing your analytics by UTM parameters: Learn how to create powerful campaign-specific reports for your links by filtering your analytics by their respective UTM tags.
• Folders role-based access control (RBAC): Learn how to set role-based access control for your folders to limit access to links for select teammates.
• Fraud detection: Safeguard your partner program by automatically flagging, reviewing, and resolving suspicious activity.
• Free .link domain offer on Dub: Learn how to get a 1-year free .link domain on Dub to create short links that match your brand and improve click-through rates.
• Free 14-day trial: Learn about the 14-day free trial on Dub, what limits apply during the trial, and what happens after it ends.
• How to use geo targeting on Dub?: Learn how to use geo targeting on Dub to redirect your users to different links based on their location.
• Configuring SAML SSO with Google Workspace: For Dub Enterprise users, you can securely manage your team's access to Dub using Google Workspace SAML SSO.
• How noindex works on Dub: Learn how Dub supports noindex response headers for short links with custom domains.
• How to add a custom domain to Dub: Learn how to add a custom domain to your Dub workspace for free - no credit card required.
• How to cancel my Dub subscription?: Learn how to cancel your Dub subscription, or downgrade to a lower plan if needed.
• How to change my Dub billing information?: Learn how to change your billing information on Dub.
• How to change my default workspace on Dub?: Learn how you can set a workspace as your default workspace on Dub.
• How can I check a Dub link's destination before clicking on it?: Learn how to check a Dub link's destination to make sure it's safe to click on.
• How to create a short link on Dub?: Learn how to create your first short link on Dub and start tracking your links.
• How to create UTM templates on Dub: Learn how to create UTM templates on Dub to streamline UTM campaign management across your team.
• How to delete my Dub account?: Learn how to delete your account on Dub
• How can I download my Dub invoice?: Learn how to download your Dub invoice.
• How to export link analytics data from Dub: Learn more about how to export link analytics data from Dub
• How to export links from Dub: Learn more about how to export your links from your Dub workspace to a CSV file.
• How to import links from a CSV file: Easily import your links from a CSV file into Dub.
• How to invite teammates on Dub: Learn how to invite teammates to your Dub workspace and start collaborating with your team.
• How to set up a redirect for your custom domain on Dub: Learn how to redirect your custom domain to a URL of your choice on Dub.
• How to set a primary domain on Dub?: Learn what a primary domain is on Dub and how to set it up.
• Setting up a bank account for partner payouts: Start paying out your program partners using your bank account (direct debit via ACH, SEPA, or PADS).
• How to transfer domains between workspaces?: Learn how to transfer your custom domains and their associated links from one Dub workspace to another.
• How to transfer links between workspaces?: Learn how to transfer your Dub default short links from one workspace to another.
• How to use Dub to shorten links on a subpath: Learn how to configure Dub to handle redirects on a subpath of an existing domain.
• How to use Tags on Dub: Easily organize & manage your links with tags on Dub.
• Importing partners: Learn how to import partners from supported platforms into your Dub program.
• Why are my analytics country or city data incorrect?: Learn why the clicks on your links might be showing up in a different country/city than expected.
• Inviting partners to your program: Learn how to invite partners to join your affiliate/referral program on Dub Partners
• How to use link cloaking on Dub?: Learn how to use link cloaking on Dub to mask your destination URL with your short link.
• How to add comments to your links in Dub?: Learn how to add comments to your links in Dub to provide more context.
• Does Dub allow for double link redirects?: Yes, Dub allows for double link redirects – where you can easily create short links for any brand you work with, improving brand recognition and revenue.
• How to set an expiration date for your Dub links?: Learn how to use automatically expire your Dub links after a certain date & time.
• Managing links with folders: Learn how to organize and manage access to your links on Dub using folders.
• Inviting your partner team: Learn how to invite team members, assign roles, and manage access to your partner profile on Dub.
• Partner details: Learn how to view and manage all your program partners, and view individual partners' profiles.
• Merging your partner accounts: Learn how to merge one of your partner accounts with another, to keep things organized and better managed.
• Messaging your partners: Learn how to use the messaging center to communicate with your partners in real time, with email notifications & read statuses built in.
• Migrating from Bitly: Easily migrate your links from Bitly to Dub in less than 3 minutes.
• Migrating from FirstPromoter: Easily migrate your affiliate program from FirstPromoter to Dub Partners in just a few clicks.
• Migrating from PartnerStack: Easily migrate your affiliate program from PartnerStack to Dub Partners in just a few clicks.
• Migrating from Rebrandly: How you can migrate from Rebrandly to Dub in a few simple steps.
• Migrating from Rewardful: Easily migrate your affiliate program from Rewardful to Dub Partners in just a few clicks.
• Migrating from Short.io: How you can migrate from Short.io to Dub in a few simple steps.
• Migrating from Tolt: Easily migrate your affiliate program from Tolt to Dub Partners in just a few clicks.
• Navigating a partner program: Learn how to navigate your programs, measure your performance, manage your referral links, and view your earnings.
• Dub Network referral bonus: Learn how the Dub Network referral bonus works and how you can share your referral link to start earning.
• Non-monetary rewards: Learn how to create non-monetary rewards (e.g. free credits, free months, etc.) for your referral partners.
• Configuring SAML SSO with Okta: For Dub Enterprise users, you can securely manage your team's access to Dub using Okta SAML SSO.
• Configuring SCIM Directory Sync with Okta: For Dub Enterprise users, you can automatically provision and deprovision users from your Okta directory to Dub using SCIM Directory Sync.
• How to pass query parameters in short links?: Learn more about how Dub supports query parameter passing from your short links to their destination URLs.
• Managing partner commissions: Learn how partner commissions work on Dub, and how to create manual commissions or clawbacks (negative commissions).
• Managing your partners with groups: Learn how you can create partner groups to segment partners by rewards, discounts, performance, location, and more.
• Configuring referral links for your partner groups: Learn how set default referral links, additional links, and UTM parameters for each partner group in your Dub partner program
• Setting business details in partner payout invoices: Learn how to set custom business details (company name, address, tax ID) in your partner payout invoices.
• Sending partner payouts on Dub: Learn more about how you can send payouts to your affiliate partners globally with Dub.
• Customizing your partner profile: Create a strong partner profile to build trust, credibility, and increase partnership opportunities on Dub.
• Partner referrals: Learn how to reward partners when they refer other partners to your program.
• Configuring partner rewards: Learn how to create custom rewards (pay-per-click, pay-per-lead, pay-per-sale) tailored to each partner with Dub Partners.
• Partner tags: Learn how to organize, filter, and manage partners with tags in your partner program.
• Frequently Asked Questions: Your quick guide to the most common partner questions.
• How to create password-protected links on Dub?: Learn how to protect your short links with a password on Dub to prevent unauthorized access.
• Measuring program performance: Track conversion rates, referral sources, UTM parameters, geolocation data and more to understand ROI and performance of your partner program.
• Customizing your program application form: Learn how to customize your program application form to collect the right information you need and select the best partners to work with for your program.
• Reviewing program applications: Learn how to manage your pending applications, and to bring the best partners to your program.
• Program bounties: Drive partner engagement by creating performance and submission bounties for your partner program
• Creating a landing page for your partner program: Create an effective and compelling landing page to attract high-quality partners to join your program and promote your product.
• Applying to programs via the Dub Program Marketplace: Explore the Dub program marketplace to discover new programs, learn what rewards they offer, and apply to the ones that fit your content and audience.
• Configuring brand and support resources for your partners: Provide partners support, help docs, program terms of service, and brand assets in their dashboard.
• Real-time events stream: Learn more about Dub's real-time events stream feature and how you can use it to gain deeper insights into your engagement data.
• Connecting your payout method to receive payouts: Learn how to connect a payout method and start receiving payouts from the affiliate programs you're working with.
• How to set a not found URL for your custom domains: Learn more about how you can set a custom not found URL for your domains on Dub.
• Setting up your program: Step-by-step guide to go from zero to a live partner program on Dub.
• How to create public analytics dashboards on Dub: Learn how to create public analytics pages for your Dub short links and link folders – with password protection and search engine indexing options.
• Troubleshooting custom domains: Learn how to troubleshoot common issues with custom domains on Dub.
• Using Cloudflare domains with Dub: Learn how to use Cloudflare domains for your Dub workspace
• Can I use a proxy on top of my Dub custom domain?: We do not recommend using a proxy (e.g. Cloudflare, Cloudfront) on top of your Dub custom domain. Here are a few reasons why.
• How do I add UTM parameters to a link?: Learn more about why UTM parameters are important for marketing links and how to add them to your links using the Dub UTM Builder.
• What is a "Workspace" on Dub?: Learn more about what a "Workspace" is on Dub and how you can use it to organize your links.
• Managing workspace members with roles: Learn how to use roles to manage your workspace members' permissions on Dub.

OpenAPI Specs

• dub-with-code-samples
• pnpm-lock
• package
• workflow
• api