Skip to main content
GET
/
partners
/
links
PHP
declare(strict_types=1);

require 'vendor/autoload.php';

use Dub;

$sdk = Dub\Dub::builder()
    ->setSecurity(
        'DUB_API_KEY'
    )
    ->build();



$response = $sdk->partners->retrieveLinks(

);

if ($response->links !== null) {
    // handle response
}
[
  {
    "id": "<string>",
    "domain": "<string>",
    "key": "<string>",
    "shortLink": "<string>",
    "url": "<string>",
    "clicks": 0,
    "leads": 0,
    "conversions": 0,
    "sales": 0,
    "saleAmount": 0
  }
]
Partners endpoints require an Advanced plan subscription or higher.

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Query Parameters

​
partnerId
string | null

The ID of the partner to create a link for. Will take precedence over tenantId if provided.

​
tenantId
string | null

The ID of the partner in your system. If both partnerId and tenantId are not provided, an error will be thrown.

Response

The retrieved partner links.

​
id
string
required

The unique ID of the short link.

​
domain
string
required

The domain of the short link. If not provided, the primary domain for the workspace will be used (or dub.sh if the workspace has no domains).

​
key
string
required

The short link slug. If not provided, a random 7-character slug will be generated.

​
shortLink
string<uri>
required

The full URL of the short link, including the https protocol (e.g. https://dub.sh/try).

​
url
string<uri>
required

The destination URL of the short link.

​
clicks
number
default:0
required

The number of clicks on the short link.

​
leads
number
default:0
required

The number of leads the short link has generated.

​
conversions
number
default:0
required

The number of leads that converted to paying customers.

​
sales
number
default:0
required

The total number of sales (includes recurring sales) generated by the short link.

​
saleAmount
number
default:0
required

The total dollar value of sales (in cents) generated by the short link.