API Docs

Get URL GET

Get single URL by :SLASHTAG or :ID using REST API endpoint: /api/v1/urls/:SLASHTAG or /api/v1/urls/:ID

Note: If you have multiple short URLs with the same "slashtag" on different domains, please use :ID based endpoint.

Request

Parameter Type Position # Description
apikey string Header Required Enter your 20-30 characters unique api key.
apisecret string Header Required Enter your 12-20 characters unique api secret.

Response

{
    "status": 200,
    "message": "ok",
    "data": {
        "id": 101,
        "destination": "http://google.ca?q=your+lengthy+destination+url",
        "hits": 100,
        "redirectCode": "301",
        "shortUrl": "http://YourBrand.com/qwerty",
        "slashtag": "qwerty",
        "createdAt": "2018-05-12 23:23:15",
        "updatedAt": "2018-05-12 23:23:15"
    }
}

With conditional tagId param. Tag ID param will be included in the response only if the URL has a tag.

{
    "status": 200,
    "message": "ok",
    "data": {
        "id": 101,
        "destination": "http://google.ca?q=your+lengthy+destination+url",
        "hits": 100,
        "redirectCode": "301",
        "shortUrl": "http://YourBrand.com/qwerty",
        "slashtag": "qwerty",
        "createdAt": "2018-05-12 23:23:15",
        "updatedAt": "2018-05-12 23:23:15",
        "tagId": 110
    }
}
											
{
    "status": 400,
    "message": "Bad request. URL slashtag is invalid or missing.",
    "data": null
}
											
{
    "status": 404,
    "message": "Not found. URL with specified slashtag doesn't exist.",
    "data": null
}