Dub

https://dub.co/docs
Admin
Dub is a modern link attribution platform that enables users to create short links, track conversion...
Tokens:528,494
Snippets:3,140
Trust Score:10
Update:21 hours ago
Show doc for...
Tokens:
Raw
### Go example to retrieve a link

Source: https://dub.co/docs/api-reference/links/retrieve

Creates an HTTP GET request with the Authorization header, sends it, and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dub.co/links/info"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

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

### Install Dub Go SDK with go get

Source: https://dub.co/docs/sdks/go

Use this command to install the Dub Go SDK package from GitHub.

```bash
go get github.com/dubinc/dub-go
```

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

### Go example to retrieve a customer

Source: https://dub.co/docs/api-reference/customers/retrieve

Uses net/http to send a GET request with an Authorization header and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dub.co/customers/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

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

### Go example for listing program applications

Source: https://dub.co/docs/api-reference/program-applications/list

Uses the net/http package to send a GET request to the Dub API endpoint. Requires an Authorization header with a bearer token.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dub.co/program-applications"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

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

### Ruby example to retrieve a link

Source: https://dub.co/docs/api-reference/links/retrieve

Uses Net::HTTP to send a GET request with the Authorization header and prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.dub.co/links/info")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

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

### Ruby example to retrieve a customer

Source: https://dub.co/docs/api-reference/customers/retrieve

Uses Net::HTTP to send a GET request with an Authorization header and prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.dub.co/customers/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

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

### Ruby example for listing program applications

Source: https://dub.co/docs/api-reference/program-applications/list

Uses Net::HTTP to send a GET request to the Dub API endpoint. Requires an Authorization header with a bearer token.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.dub.co/program-applications")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

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

### Go example to retrieve a link

Source: https://dub.co/docs/api-reference/links/retrieve

Uses the net/http package to send a GET request to the Dub API endpoint /links/info with an Authorization header. Prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dub.co/links/info"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

```

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

### Install @dub/better-auth with bun

Source: https://dub.co/docs/conversions/leads/better-auth

Use bun to install the @dub/better-auth plugin.

```bash
bun add @dub/better-auth
```

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

### Install @dub/analytics with bun

Source: https://dub.co/docs/sdks/client-side/installation-guides/react

Install the @dub/analytics package using bun.

```bash
bun add @dub/analytics
```

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

### Set up initial environment variables

Source: https://dub.co/docs/self-hosting

Converts .env.example to .env and fills in the first few environment variables: NEXT_PUBLIC_APP_DOMAIN, NEXT_PUBLIC_APP_SHORT_DOMAIN, TEAM_ID_VERCEL, and AUTH_BEARER_TOKEN. The remaining variables are filled in later steps.

```bash
# The domain that your app will be hosted on
NEXT_PUBLIC_APP_DOMAIN=acme.com
# The short domain that your app will be using (could be the same as the above)
NEXT_PUBLIC_APP_SHORT_DOMAIN=ac.me
# The ID of the Vercel team that your app will be deployed to: https://vercel.com/docs/accounts/create-a-team#find-your-team-id
TEAM_ID_VERCEL=
# The unique access token for your Vercel account: https://vercel.com/guides/how-do-i-use-a-vercel-api-access-token
AUTH_BEARER_TOKEN=
```

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

### GET /links

Source: https://dub.co/docs/api-reference/introduction

Retrieve a paginated list of links. This example fetches the first page of 10 links.

```APIDOC
## GET /links

### Description
Retrieve a paginated list of links. This example fetches the first page of 10 links.

### Method
GET

### Endpoint
https://api.dub.co/links

### Parameters
#### Query Parameters
- **page** (string) - Optional - The page number to retrieve. Default: "1".
- **pageSize** (string) - Optional - The number of items to retrieve per page. Default varies by endpoint. Maximum value is 100.
- **sortBy** (string) - Optional - The field to sort the results by.
- **sortOrder** (string) - Optional - The order to sort the results by. Can be `asc` or `desc`.

### Request Example
```
curl --request GET \
  --url https://api.dub.co/links?page=1&pageSize=10 \
  --header 'Authorization: Bearer <token>'
```

### Response
#### Success Response (200)
- **links** (array) - List of links for the requested page.

#### Response Example
```
{
  "links": []
}
```
```

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

### Set up Dub SDK and track leads

Source: https://dub.co/docs/conversions/leads/appwrite

Create the Dub client and send leads using dub.track.lead(). Save as src/lib/server/dub.ts.

```ts
import type { Models } from 'node-appwrite';
import { Dub } from 'dub';

const dub = new Dub({
  token: process.env.NEXT_DUB_API_KEY
});

export function addDubLead(user: Models.User<Models.Preferences>, dub_id: string) {
  dub.track.lead({
    clickId: dub_id,
    eventName: 'Sign Up',
    customerExternalId: user.$id,
    customerName: user.name,
    customerEmail: user.email
  });
}
```

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

### Go example to register a domain

Source: https://dub.co/docs/api-reference/domains/register

Uses net/http to send a POST request with a JSON payload. Prints the response body.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dub.co/domains/register"

	payload := strings.NewReader("{\n  \"domain\": \"acme.link\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

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

### Authenticate with Dub API using cURL

Source: https://dub.co/docs/api-reference/introduction

Example of a GET request to the /links endpoint using cURL with the Authorization header.

```bash
curl --request GET \
  --url https://api.dub.co/links \
  --header 'Authorization: Bearer dub_xxxxxx'
```

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

### Go example for POST /track/open

Source: https://dub.co/docs/api-reference/track/open

Uses net/http to send a POST request with a JSON body. Prints the response body.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dub.co/track/open"

	payload := strings.NewReader("{\n  \"deepLink\": \"<string>\",\n  \"dubDomain\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

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

### Success response: Create a folder

Source: https://dub.co/docs/api-reference/folders/create

Example 201 response body for a successfully created folder, containing id, name, description, type, accessLevel, createdAt, and updatedAt.

```json
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "type": "default",
  "accessLevel": "write",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

```

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

### Go example for approving a partner application

Source: https://dub.co/docs/api-reference/program-applications/approve

Uses the net/http package to send a POST request with the approval payload. Prints the response body.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dub.co/program-applications/approve"

	payload := strings.NewReader("{\n  \"partnerId\": \"<string>\",\n  \"applicationId\": \"<string>\",\n  \"groupId\": \"<string>\",\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"tagNames\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

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

### Java Unirest example to retrieve a link

Source: https://dub.co/docs/api-reference/links/retrieve

Uses Unirest to send a GET request with the Authorization header and returns the response as a string.

```java
HttpResponse<String> response = Unirest.get("https://api.dub.co/links/info")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

### Fetch workspace-level analytics with dub.analytics.retrieve (Ruby)

Source: https://dub.co/docs/api-reference/rate-limits

Ruby example for retrieving workspace-level analytics, using natural language for the start parameter.

```Ruby
req = ::OpenApiSDK::Operations::RetrieveAnalyticsRequest.new(
  group_by: ::OpenApiSDK::Operations::GroupBy::TOP_LINKS,
  start: "4 hours ago",  # we support natural language for start/end params
)

res = dub.analytics.retrieve(req)

puts res.raw_response.body
```

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

### Go example to reject a partner application

Source: https://dub.co/docs/api-reference/program-applications/reject

Uses net/http to send a POST request with the rejection payload. Prints the response body.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dub.co/program-applications/reject"

	payload := strings.NewReader("{\n  \"partnerId\": \"<string>\",\n  \"rejectionNote\": \"<string>\",\n  \"reapplicationTimeframe\": \"standard\",\n  \"flagForFraud\": true,\n  \"flagForFraudReason\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

```

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

### Go example to reject a partner application

Source: https://dub.co/docs/api-reference/program-applications/reject

Uses net/http to send a POST request with the rejection payload as a JSON string. Prints the response body.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dub.co/program-applications/reject"

	payload := strings.NewReader("{\n  \"partnerId\": \"<string>\",\n  \"rejectionNote\": \"<string>\",\n  \"reapplicationTimeframe\": \"standard\",\n  \"flagForFraud\": true,\n  \"flagForFraudReason\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

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

### Fetch workspace-level analytics with d.analytics.retrieve (Python)

Source: https://dub.co/docs/api-reference/rate-limits

Python example for retrieving workspace-level analytics, using natural language for the start parameter.

```Python
res = d.analytics.retrieve(request={
    "groupBy": "top_links",
    "start": "4 hours ago",  # we support natural language for start/end params
})
```

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

### PHP cURL example to retrieve a link

Source: https://dub.co/docs/api-reference/links/retrieve

Configures a cURL session to send a GET request with the Authorization header and outputs the response or error.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dub.co/links/info",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

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

### JavaScript fetch example to retrieve a link

Source: https://dub.co/docs/api-reference/links/retrieve

Uses fetch to send a GET request with the Authorization header, then logs the JSON response or error.

```javascript
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dub.co/links/info', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

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

### Python requests example to retrieve a link

Source: https://dub.co/docs/api-reference/links/retrieve

Uses the requests library to send a GET request to the endpoint with the Authorization header and prints the response text.

```python
import requests

url = "https://api.dub.co/links/info"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

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

### Generate Prisma client and create database tables

Source: https://dub.co/docs/local-development

Run these commands in the apps/web directory to generate the Prisma client and then create the database tables. These commands are used in both Option 1 and Option 2.

```bash
pnpm run prisma:generate
```

```bash
pnpm run prisma:push
```

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

### Start Docker Compose stack

Source: https://dub.co/docs/local-development

Run this command in the apps/web directory to start the Docker Compose stack, which launches containers for MySQL and the PlanetScale simulator.

```bash
docker compose up
```

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

### Java Unirest example to retrieve a customer

Source: https://dub.co/docs/api-reference/customers/retrieve

Uses the Unirest HTTP library to send a GET request with an Authorization header and returns the response as a string.

```java
HttpResponse<String> response = Unirest.get("https://api.dub.co/customers/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

### Tinybird deployment output

Source: https://dub.co/docs/local-development

Example output when the deployment is live.

```bash
Deployment URL: https://cloud.tinybird.co/aws/us-east-1/<workspace-name>/deployments/<deployment-id>
Job API URL: https://api.us-east.aws.tinybird.co/v0/jobs/<job-id>
Jobs URL: https://cloud.tinybird.co/aws/us-east-1/<workspace-name>/jobs

* Deployment submitted. It will be auto-promoted when ready.
» Waiting for deployment to be ready...
✓ Deployment is ready
» Waiting for deployment to be promoted...
✓ Deployment promoted
✓ Deployment #1 is live!
```

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

### PHP cURL example to retrieve a customer

Source: https://dub.co/docs/api-reference/customers/retrieve

Uses PHP cURL to send a GET request with an Authorization header. Handles errors and prints the response.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dub.co/customers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

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

### Go example to approve a bounty submission

Source: https://dub.co/docs/api-reference/bounties/approve

Uses net/http to send a POST request with a JSON body containing rewardAmount. Prints the response body.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dub.co/bounties/{bountyId}/submissions/{submissionId}/approve"

	payload := strings.NewReader("{\n  \"rewardAmount\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

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

### JavaScript fetch example to retrieve a customer

Source: https://dub.co/docs/api-reference/customers/retrieve

Uses the fetch API to send a GET request with an Authorization header, then logs the JSON response or error.

```javascript
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dub.co/customers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

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

### Install @dub/better-auth with npm

Source: https://dub.co/docs/conversions/leads/better-auth

Use npm to install the @dub/better-auth plugin.

```bash
npm install @dub/better-auth
```

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

### Python requests example to retrieve a customer

Source: https://dub.co/docs/api-reference/customers/retrieve

Uses the requests library to send a GET request to the customer endpoint with an Authorization header. Prints the response text.

```python
import requests

url = "https://api.dub.co/customers/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

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

### Set up database environment variables

Source: https://dub.co/docs/local-development

Add these credentials to your .env file to configure the local MySQL database and the PlanetScale simulator. The DATABASE_URL is used for the local MySQL database, and PLANETSCALE_DATABASE_URL points to the simulator.

```env
DATABASE_URL="mysql://root:@localhost:3306/planetscale"
PLANETSCALE_DATABASE_URL="http://root:unused@localhost:3900/planetscale"
```

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

### Initialize Dub Go SDK

Source: https://dub.co/docs/sdks/quickstart/go

Initialize the Dub Go SDK by creating a new instance of the Dub struct with your API key.

```APIDOC
## Initialize Dub Go SDK

### Description
Initialize the Dub Go SDK by creating a new instance of the `Dub` struct with your API key.

### Code Example
```go
package main

import (
	"log"
	"os"
	"context"
	dub "github.com/dubinc/dub-go"
)

d := dub.New(
	dub.WithSecurity(os.Getenv("DUB_API_KEY")),
)
```
```

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

### Install Dub Ruby SDK with gem

Source: https://dub.co/docs/sdks/ruby

Install the Dub Ruby SDK using the gem command.

```bash
gem install dub
```

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

### PHP cURL example for listing program applications

Source: https://dub.co/docs/api-reference/program-applications/list

Uses PHP cURL to send a GET request to the Dub API endpoint. Requires an Authorization header with a bearer token.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dub.co/program-applications",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

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

### JavaScript fetch example for listing program applications

Source: https://dub.co/docs/api-reference/program-applications/list

Uses the fetch API to send a GET request to the Dub API endpoint. Requires an Authorization header with a bearer token.

```javascript
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dub.co/program-applications', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```
Tokens:
Raw