Shortlinks
Manage short URL redirection, monitor traffic attribution, and control shortlink lifecycle.
Shortlinks API
The Shortlinks API enables organizations to transform complex destination URLs into concise links. Beyond simple redirection, the system provides integrated telemetry for traffic attribution, enabling teams to monitor engagement performance in real time across distribution channels.
Link Lifecycle Management
Audit Shortlink Directory
Retrieve a paginated directory of all shortlinks associated with your organization. This inventory includes current operational status and destination metadata.
shortlinks:readApiAccessPermission::SHORTLINKS_READQuery Parameters
sizeintegerpageintegerResponses
Shortlink inventory successfully retrieved.
{
"entities": "Shortlink",
"count": 42,
"per_page": 100,
"pages": {
"current": 1,
"max": 1
},
"elements": [
{
"id": "675d9fea...",
"title": "Spring 2026 Campaign",
"original_url": "https://marketing.acme.com/promo/spring",
"short_code": "k9x2m-spr26",
"url": "https://d.dw2.it/r/k9x2m-spr26",
"is_active": true
}
]
}Provision New Shortlink
Generate a new shortlink for a target destination.
You can optionally provide a custom fragment (bitly-style suffix). The platform always prepends an auto-generated prefix to reduce collision risk.
shortlinks:writeApiAccessPermission::SHORTLINKS_WRITEQuery Parameters
No query parameters required.
Request Body
{
"shortlink": {
"title": "Product Launch Announcement",
"original_url": "https://acme.com/products/new-gen-ai",
"fragment": "launch-2026",
"is_active": true
}
}shortlink.titlestringRequiredshortlink.original_urlstringRequiredshortlink.fragmentstringshortlink.is_activebooleanResponses
Shortlink successfully provisioned.
{
"shortlink": {
"id": "6768440..."
},
"short_code": "k9x2m-launch-2026",
"url": "https://d.dw2.it/r/k9x2m-launch-2026"
}Requested custom fragment is already in use.
{
"error": "This shortlink fragment is already in use"
}Retrieve Link Configuration
Fetch the detailed configuration and operational status for a specific shortlink.
shortlinks:readApiAccessPermission::SHORTLINKS_READQuery Parameters
shortlinkIdstringRequiredResponses
Shortlink configuration retrieved.
{
"id": "675d9fea...",
"title": "Spring 2026 Campaign",
"original_url": "https://marketing.acme.com/promo/spring",
"short_code": "k9x2m-spr26",
"url": "https://d.dw2.it/r/k9x2m-spr26",
"is_active": true
}Operational Controls
Update Link Parameters
Modify the destination URL, custom fragment, or operational status of an existing shortlink. Link updates are propagated across the redirection edge in near real-time.
When updating fragment, the existing auto-generated prefix is preserved.
shortlinks:writeApiAccessPermission::SHORTLINKS_WRITEQuery Parameters
shortlinkIdstringRequiredRequest Body
{
"shortlink": {
"title": "Revised Spring Campaign",
"original_url": "https://marketing.acme.com/promo/spring-final",
"fragment": "spring-final",
"is_active": true
}
}shortlink.titlestringRequiredshortlink.original_urlstringRequiredshortlink.fragmentstringshortlink.is_activebooleanResponses
Configuration updated successfully.
{
"shortlink": {
"id": "675d9fea..."
},
"short_code": "k9x2m-spring-final",
"url": "https://d.dw2.it/r/k9x2m-spring-final"
}Requested custom fragment is already in use.
{
"error": "This shortlink fragment is already in use"
}Revoke Shortlink
Permanently revoke a shortlink and decommission its redirection service.
shortlinks:writeApiAccessPermission::SHORTLINKS_WRITEQuery Parameters
shortlinkIdstringRequiredResponses
Shortlink successfully revoked.
{
"id": "675d9fea...",
"deleted": true
}Analytics & Telemetry
Retrieve Interaction Metrics
Access real-time engagement telemetry for a specific shortlink. This include visit counts, unique interactions, and longitudinal performance data.
shortlinks:readApiAccessPermission::SHORTLINKS_READQuery Parameters
shortlinkIdstringRequiredResponses
Engagement metrics successfully aggregated.
{
"shortlink": {
"id": "675d9fea...",
"title": "Spring 2026 Campaign",
"original_url": "https://marketing.acme.com/promo/spring",
"short_code": "k9x2m-spr26",
"is_active": true,
"url": "https://d.dw2.it/r/k9x2m-spr26",
"created_at": 1772536800
},
"metrics": {
"summary": {
"human": 1530,
"bot": 12,
"total": 1542
},
"view_density": [
{
"country": "IT",
"count": 600
},
{
"country": "US",
"count": 420
}
],
"referrers": {
"Direct": 900,
"linkedin.com": 350,
"newsletter.acme.com": 292
},
"bots": {
"Google": 7,
"Facebook": 5
},
"browsers": {
"Chrome": 1100,
"Safari": 320,
"Firefox": 110
},
"os": {
"Windows": 620,
"macOS": 410,
"iOS": 320,
"Android": 180
}
}
}Technical Implementation
const shortlinkId = "675d9fea...";
try {
const stats = await sdk.dw2.getStats(shortlinkId);
console.log(`Campaign Performance: ${stats.metrics.summary.total} total interactions.`);
} catch (error) {
console.error(`Telemetry Error: ${error.message}`);
}