GET
/
links
/
:id
curl \
-H "Authorization: Bearer API_Key" \
-H 'Content-Type: application/json' \
-X GET https://api.ayrshare.com/api/links/yC0fTl

{
    "status": "success",
    "analytics": {
        "browserCounts": {
            "chrome": 15
        },
        "created": "2023-06-29T00:57:12.220Z",
        "id": "yC0fTl",
        "originalUrl": "https://www.ayrshare.com/?utm_source=google_ads",
        "refererCounts": {},
        "shortUrl": "https://ayrs.io/yC0fTl",
        "socialClicks": {},
        "status": "success",
        "totalClicks": 15,
        "utmSource": "google_ads"
    }
}
Available on Business, Enterprise plans.Max Pack required

Return analytics for all shortened links or a single link for a given link ID. For example:

  • https://api.ayrshare.com/api/links/yC0fTl returns analytics for ID yC0fTl
  • https://api.ayrshare.com/api/links returns all link analytics.

​
Header Parameters

​
Authorization
string
required
API Key of the Primary Profile.

Format: Authorization: Bearer API_KEY

​
Path Parameters

​
id
string

Provide the shortened link ID returned from the POST /links request as a path parameter. For example: https://api.ayrshare.com/api/links/yC0fTl If no link ID is provided, all links are returned.

​
Query Parameters

​
fromCreatedDate
string

Get history of links shortened after this date. Accepts a UTC date time. For example, use format YYYY-MM-DDThh:mm:ssZ and send as 2023-07-08T12:30:00Z.

​
toCreatedDate
string

Get history of links shortened before this date. Accepts a UTC date time. For example, use format YYYY-MM-DDThh:mm:ssZ and send as 2023-07-08T12:30:00Z.

​
fromClickDate
string

Get history of links clicked after this date. Accepts a UTC date time. For example, use format YYYY-MM-DDThh:mm:ssZ and send as 2023-07-08T12:30:00Z.

​
toClickDate
string

Get history of links clicked before this date. Accepts a UTC date time. For example, use format YYYY-MM-DDThh:mm:ssZ and send as 2023-07-08T12:30:00Z.

curl \
-H "Authorization: Bearer API_Key" \
-H 'Content-Type: application/json' \
-X GET https://api.ayrshare.com/api/links/yC0fTl

{
    "status": "success",
    "analytics": {
        "browserCounts": {
            "chrome": 15
        },
        "created": "2023-06-29T00:57:12.220Z",
        "id": "yC0fTl",
        "originalUrl": "https://www.ayrshare.com/?utm_source=google_ads",
        "refererCounts": {},
        "shortUrl": "https://ayrs.io/yC0fTl",
        "socialClicks": {},
        "status": "success",
        "totalClicks": 15,
        "utmSource": "google_ads"
    }
}