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

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

Documentation Index

Fetch the complete documentation index at: https://www.ayrshare.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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://ayrshare.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

​
Body Parameters

​
url
string
required
URL to be shortened. Must be a valid URL starting with https://
​
utmId
string
Used to identify which Google Analytics ads campaign this referral references.
​
utmSource
string
Used to identify a search engine, newsletter name, or other source.
​
utmMedium
string
Used to identify a medium such as email or cost-per-click.
​
utmCampaign
string
Used for keyword analysis. Used to identify a specific product promotion or strategic campaign.
​
utmTerm
string
Used for paid search. Used to note the keywords for this ad.
​
utmContent
string
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.ayrshare.com", "utmSource": "google_ads"}' \
-X POST https://api.ayrshare.com/api/links

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