Retrieve a partner's links.

Retrieve a partner's links by their partner ID or tenant ID.

1 min read

get/partners/links

Request example

from dub import Dub


with Dub(
    token="DUB_API_KEY",
) as d_client:

    res = d_client.partners.retrieve_links(request={})

    # Handle response
    print(res)

Response

[
  {
    "id": "<string>",
    "domain": "<string>",
    "key": "<string>",
    "shortLink": "<string>",
    "url": "<string>",
    "clicks": 0,
    "leads": 0,
    "conversions": 0,
    "sales": 0,
    "saleAmount": 0
  }
]

get/partners/links

Authorization

Authorizationstringheaderrequired#

Default authentication mechanism

Query parameters

partnerIdstring#

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

tenantIdstring#

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

Responses

application/json

The retrieved partner links.

idstringrequired#

The unique ID of the short link.

domainstringrequired#

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).

keystringrequired#

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

shortLinkstringrequired#

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

urlstringrequired#

The destination URL of the short link.

clicksnumberrequired#

The number of clicks on the short link.

Default: 0

leadsnumberrequired#

The number of leads the short link has generated.

Default: 0

conversionsnumberrequired#

The number of leads that converted to paying customers.

Default: 0

salesnumberrequired#

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

Default: 0

saleAmountnumberrequired#

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

Default: 0

Upsert partner link List applications