Link Management

Generate example links for a domain

Creates a set of demo/example links to showcase various features of the short link service.

Example links include:

A/B testing with split URLs
Mobile targeting (different URLs for Android/iPhone)
Expiring links with time limits
File download links
Password-protected links

Returns 404 if the domain does not exist in your organization.

Rate limit: 5/10s

post/links/examples

Request

Base URL: https://api.short.io
URL: https://api.short.io/links/examples
Auth: API key in header Authorization

Request body

domainstring hostname required

Domain hostname to create examples for

Response

Default Response

successboolean required

Whether the example links were created

Example response

{
  "success": true,
  "links": [
    {
      "originalURL": "https://example.com",
      "password": "s3cur3p@ssw0rd",
      "expiredURL": "https://example.com/expired",
      "utmSource": "cpc",
      "utmMedium": "banner",
      "utmCampaign": "summer_sale",
      "utmTerm": "running_shoes",
      "utmContent": "cta_button",
      "androidURL": "https://play.google.com/store/apps/details?id=com.example.app",
      "iphoneURL": "https://apps.apple.com/us/app/example-app/id1234567890",
      "clicksLimit": 100,
      "splitURL": "https://example.com/split",
      "splitPercent": 50,
      "shortURL": "https://short.gy/abc123",
      "secureShortURL": "https://short.gy/abc123",
      "path": "my-link",
      "displayPath": "My-Link",
      "FolderId": "abc123",
      "DomainId": 1,
      "OwnerId": 1,
      "source": "api",
      "pageType": 2,
      "User": {
        "id": 123,
        "name": "John Doe",
        "email": "a@example.com",
        "photoURL": "https://example.com/photo.jpg"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.