Create Short Link

POSThttps://api.acme.com/api/links

Available on Business, Enterprise plans.Max Pack required

Provide a URL and a shortened link will be returned. Analytics can then be gathered on the clicks, browser type, etc.

Submitting the same URL for shortening will always result in the same shortened link. To generate a unique shortened link for the same URL, you can add extra query parameters to it. For example, appending a unique identifier like https://acme.com?uniqueId=123 will create a distinct shortened link.

You may also include UTM parameters, which will be embedded in the shortened URL link.

Header Parameters

Authorizationstringrequired

API Key of the Primary Profile.

Format: Authorization: Bearer API_KEY

Body Parameters

urlstringrequired

URL to be shortened. Must be a valid URL starting with https://

utmIdstring

Used to identify which Google Analytics ads campaign this referral references.

utmSourcestring

Used to identify a search engine, newsletter name, or other source.

utmMediumstring

Used to identify a medium such as email or cost-per-click.

utmCampaignstring

Used for keyword analysis. Used to identify a specific product promotion or strategic campaign.

utmTermstring

Used for paid search. Used to note the keywords for this ad.

utmContentstring

Used for A/B testing and content-targeted ads. Used to differentiate ads or links that point to the same URL.

curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{"url": "https://www.acme.com", "utmSource": "google_ads"}' \
-X POST https://api.acme.com/api/links

{
    "created": "2023-07-17T15:20:51.118Z",
    "id": "yC0fTl",
    "originalUrl": "https://www.acme.com/?utm_source=looking",
    "shortUrl": "https://ayrs.io/yC0fTl",
    "status": "success",
    "utmSource": "looking"
}