Skip to main content

​
Installation

npm install dub

​
Basic Usage

Here’s how you can use the Dub TypeScript SDK to create a link and retrieve click analytics in timeseries format for it: 
import { Dub } from "dub";

// Initialize the Dub SDK with your API key
const dub = new Dub({
  token: process.env.DUB_API_KEY, // optional, defaults to DUB_API_KEY
});

// Create a new link
const link = await dub.links.create({
  url: "https://google.com",
});

console.log(link.shortLink); // e.g. https://dub.sh/abc123

// Get analytics for the link
const analytics = await dub.analytics.retrieve({
  link_id: link.id,
  groupBy: "timeseries",
  interval: "30d",
});

console.log(analytics); // e.g. [{ start: "2024-01-01", clicks: 100 }]
For more usage examples:
  1. Organizing links by external ID, tenant ID, tags, etc
  2. Bulk link operations (create, update, delete)
  3. Retrieving link analytics

​
Frameworks

You can use the Dub TypeScript SDK with any JavaScript framework:
  1. Usage with Next.js
  2. Usage with Remix
  3. Usage with Nuxt
  4. Usage with Express
If you’re using a different JavaScript framework, you can refer to the TypeScript SDK quickstart for a basic example.

​
Additional Resources

NPM Package

Download and install the Dub TypeScript SDK on NPM

SDK Reference

View the complete SDK reference documentation

Examples

Quickstart examples with the TypeScript SDK

Source Code

View the complete source code for the Dub TypeScript SDK