Developer API - URLR (0.2)

Download OpenAPI specification:Download

Welcome to the URLR developer API documentation.

Requirements:

A valid URLR account (with verified email)
A paid subscription that gives access to API
Any language you can make an HTTP request with

Authentification

Get an access token

Request Body schema: application/json

Your credentials

username	string
password	string

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string"
}

Response samples

200
401

Content type

application/json

{"token": "string"
}

Link

Reduce a link

Authorizations:

bearerAuth

Request Body schema: application/json

Infos of the link to reduce

url required	string The url to reduce
team	string Team id (displayed on dashboard)
folder	string Folder id (displayed on dashboard)
code	string Custom code
label	string Link label
password	string Link password
expired_at	string Expiration date

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"team": "string",
"folder": "string",
"code": "string",
"label": "string",
"password": "string",
"expired_at": "string"
}

Response samples

200
400

Content type

application/json

{"url": "string",
"expired_at": "string",
"team": "string",
"folder": "string",
"url_code": "xMs5c",
"domain": "urlr.me",
"code": 200
}

Stats

Get statistics of a link

Authorizations:

bearerAuth

Request Body schema: application/json

Infos to provide to get statistics of a link

code required	string The short-code of the url
from	string Get stats from this date
to	string Get stats until this date
includeBots	boolean Whether include bots or not in statistics

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"from": "dd/mm/yyyy",
"to": "dd/mm/yyyy",
"includeBots": true
}

Response samples

200
400

Content type

application/json

{"clicks": 32,
"uniqueClicks": 51
}