GET
/
links
/
info
Ruby
require 'dub'

Models = ::OpenApiSDK::Models
s = ::OpenApiSDK::Dub.new(
      security: Models::Shared::Security.new(
        token: 'DUB_API_KEY',
      ),
    )

req = Models::Operations::GetLinkInfoRequest.new(
  link_id: 'clux0rgak00011...',
  external_id: '123456',
)

res = s.links.get(request: req)

unless res.nil?
  # handle response
end
{
  "id": "<string>",
  "domain": "<string>",
  "key": "<string>",
  "url": "<string>",
  "trackConversion": false,
  "externalId": "<string>",
  "tenantId": "<string>",
  "programId": "<string>",
  "partnerId": "<string>",
  "archived": false,
  "expiresAt": "<string>",
  "expiredUrl": "<string>",
  "password": "<string>",
  "proxy": false,
  "title": "<string>",
  "description": "<string>",
  "image": "<string>",
  "video": "<string>",
  "rewrite": false,
  "doIndex": false,
  "ios": "<string>",
  "android": "<string>",
  "geo": {},
  "publicStats": false,
  "tags": [
    {
      "id": "<string>",
      "name": "<string>",
      "color": "red"
    }
  ],
  "folderId": "<string>",
  "webhookIds": [
    "<string>"
  ],
  "comments": "<string>",
  "shortLink": "<string>",
  "qrCode": "<string>",
  "utm_source": "<string>",
  "utm_medium": "<string>",
  "utm_campaign": "<string>",
  "utm_term": "<string>",
  "utm_content": "<string>",
  "testVariants": [
    {
      "url": "https://example.com/variant-1",
      "percentage": 50
    },
    {
      "url": "https://example.com/variant-2",
      "percentage": 50
    }
  ],
  "testStartedAt": "<string>",
  "testCompletedAt": "<string>",
  "userId": "<string>",
  "workspaceId": "<string>",
  "clicks": 0,
  "leads": 0,
  "conversions": 0,
  "sales": 0,
  "saleAmount": 0,
  "lastClicked": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "tagId": "<string>",
  "projectId": "<string>"
}
You can retrieve a link by providing one of the following as a query parameter:
  • domain and key.
  • linkId.
  • externalId.

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Query Parameters

​
domain
string

The domain of the link to retrieve. E.g. for d.to/github, the domain is d.to.

Minimum length: 1
​
key
string

The key of the link to retrieve. E.g. for d.to/github, the key is github.

Minimum length: 1
​
linkId
string

The unique ID of the short link.

Example:

"clux0rgak00011..."

​
externalId
string

This is the ID of the link in the your database.

Example:

"123456"

Response

200
application/json

The retrieved link

The response is of type object.