Dub

https://dub.co/help
Admin
Dub is a marketing platform for creating short links, managing affiliate programs, and tracking...
Tokens:57,522
Snippets:682
Trust Score:10
Update:9 months ago
Show doc for...
Tokens:
Raw
### Secure Link Cloaking Demo Code Example

Source: https://dub.co/help/article/link-cloaking

A code example demonstrating secure link cloaking. This is likely a repository or project setup that illustrates the implementation of the described security headers and cloaking functionality.

```git
git.new/zAD0CkJ
```

--------------------------------

### Reward Examples

Source: https://dub.co/help/article/partner-rewards

Examples of different reward configurations including Geo-specific, Product spotlight, Partner performance tiers, and Sale reward tiers.

```APIDOC
## Reward examples

Here are a few reward examples with their conditions to give you some starting ideas.

1. **Geo-specific**
   When your partners have conversions from specific countries, reward them with a higher percentage.
   **Condition #1**
   If `Customer` `Country` `is one of` `Canada, United States, Mexico`

2. **Product spotlight**
   Tailor your reward amount by product. In this example, we're rewarding more when the sale is for the Gold Plan.
   **Condition #1**
   If `Sale` `Product ID` `is` `Your product ID`
   Show as `Gold Plan` (what the partner sees)
   Where `Your product ID` is listed, you'll enter your product ID (the screenshot uses an example product ID)
   If you're using our Stripe integration, the product ID will be the Stripe product ID that the subscription is for (starts with `prod_xxx`).
   If you're manually tracking a sale event via our `/track/sale` endpoint, you can pass along the product ID via the metadata prop (e.g. `metadata.productId = "prod_xxx"`).

3. **Partner performance tiers**
   For creating tiered rewards based on performance. In this example, our base reward is the smallest, and each condition is larger, starting at 50% and growing to 60% based on how many conversions the partner has.
   **Condition #1**
   If `Partner` `Total conversions` `is greater than or equal to` `100`
   **Condition #2**
   If `Partner` `Total conversions` `is greater than or equal to` `200`

4. **Sale reward tiers**
   For creating tiered rewards based on customer sales. In this example, we're giving our partners a higher reward if the sale amount is over a specific dollar amount.
   **Condition #1**
   If `Sale` `Amount` `is greater than or equal to` `$100`
```

--------------------------------

### Configure Subpath Redirects with Nuxt.js

Source: https://dub.co/help/article/how-to-use-dub-with-subpath

This example demonstrates how to set up subpath redirects in a Nuxt application using server routes. It creates a catch-all route for `/r/[...slug]` and redirects requests to a Dub subdomain.

```typescript
export default defineEventHandler(async (event) => {
  const dubPath = getRouterParam(event, "slug");
  await sendRedirect(event, `https://r.acme.com/${dubPath}`, 301); // use whatever status code you need
});
```

--------------------------------

### Create Link with Primary Domain (TypeScript SDK)

Source: https://dub.co/help/article/how-to-set-primary-domain

This code snippet demonstrates how to create a link using the Dub TypeScript SDK. It shows how the `domain` parameter is optional and defaults to the primary domain if not specified. Ensure you have the Dub SDK installed.

```typescript
import { Dub } from "dub";

const dub = new Dub();

async function main() {
  const link = await dub.links.create({
    url: "string",
    domain: "dub.sh", // (optional - defaults to primary domain)
  });

  console.log(link);
}

main();
```

--------------------------------

### Create Link with Custom Video Preview (TypeScript)

Source: https://dub.co/help/article/custom-link-previews

Demonstrates how to create a link with custom image and video previews using the Dub API. Requires the 'dub' package and enabling proxy for previews to function. The 'image' parameter serves as a fallback for platforms not supporting 'og:video'.

```typescript
import { Dub } from "dub";

const dub = new Dub();

await dub.links.create({
  url: "https://example.com",
  proxy: true, // proxy has to enabled for custom link previews to work
  image: "https://example.com/image.png", // it's recommended to pass a fallback image for platforms that don't support og:video
  video: "https://example.com/video.mp4", 
});
```

--------------------------------

### Example Index Response Header (HTTP)

Source: https://dub.co/help/article/how-noindex-works

This snippet illustrates the HTTP response headers when indexing is enabled for a short link. It shows a 302 redirect but lacks the `X-Robots-Tag: noindex` header, allowing search engines to index the link.

```http
GET /doindex HTTP/2
Host: d.to
User-Agent: curl/8.6.0

HTTP/2 302
location: https://dub.co/help/article/how-noindex-works
X-Powered-By: Dub.co
```

--------------------------------

### Reward Preview

Source: https://dub.co/help/article/partner-rewards

The reward preview automatically populates with your settings during reward creation, showing you exactly what your partner will see on your program details and within their dashboard.

```APIDOC
## Reward preview

During the creation of your rewards, the reward preview will populate with the settings you've provided. This preview allows you to see exactly what your partner will see on your program details and within their dashboard.
```

--------------------------------

### Example Noindex Response Header (HTTP)

Source: https://dub.co/help/article/how-noindex-works

This snippet demonstrates the HTTP response headers when a short link is configured with `noindex` on a custom domain. It shows a 302 redirect and the `X-Robots-Tag: noindex` header, indicating that search engines should not index this page.

```http
GET /noindex HTTP/2
Host: d.to
User-Agent: curl/8.6.0

HTTP/2 302
location: https://dub.co/help/article/how-noindex-works
X-Robots-Tag: noindex
X-Powered-By: Dub.co
```

--------------------------------

### Initialize Dub SDK and Handle Deep Links in React Native

Source: https://dub.co/help/article/custom-domain-deep-links

Initializes the Dub SDK for React Native and handles deep links. It checks for the first launch to manage initial deep links and sets up a listener for subsequent deep link events. Requires @dub/react-native and @react-native-async-storage/async-storage.

```javascript
import {
  useState,
  useEffect,
  useRef
} from "react";
import {
  Linking
} from "react-native";
import AsyncStorage from "@react-native-async-storage/async-storage";
import dub from "@dub/react-native";

export default function App() {
  useEffect(() => {
    dub.init({
      publishableKey: "<DUB_PUBLISHABLE_KEY>",
      domain: "<DUB_DOMAIN>",
    });

    // Check if this is first launch
    const isFirstLaunch = await AsyncStorage.getItem("is_first_launch");

    if (isFirstLaunch === null) {
      await handleFirstLaunch();
      await AsyncStorage.setItem("is_first_launch", "false");
    } else {
      // Handle initial deep link url (Android only)
      const url = await Linking.getInitialURL();

      if (url) {
        await handleDeepLink(url);
      }
    }

    const linkingListener = Linking.addEventListener("url", (event) => {
      handleDeepLink(event.url);
    });

    return () => {
      linkingListener.remove();
    };
  }, []);

  const handleFirstLaunch = async (
    deepLinkUrl?: string | null | undefined
  ): Promise<void> => {
    try {
      const response = await dub.trackOpen(deepLinkUrl);

      const destinationURL = response.link?.url;
      // Navigate to the destination URL
    } catch (error) {
      // Handle error
    }
  };

  // Return your app...
}

```

--------------------------------

### Tracking Sale with Product ID via Metadata

Source: https://dub.co/help/article/partner-rewards

This snippet demonstrates how to pass a product ID when manually tracking a sale event using the `/track/sale` endpoint. It utilizes the `metadata` property to include the `productId`, which is crucial for product-specific reward configurations.

```javascript
dub.track('sale', {
  amount: 100,
  metadata: {
    productId: "prod_xxx"
  }
});
```
Tokens:
Raw