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

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "token": "string"
}

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

Content type
application/json
{
  • "code": "string",
  • "from": "dd/mm/yyyy",
  • "to": "dd/mm/yyyy",
  • "includeBots": true
}

Response samples

Content type
application/json
{
  • "clicks": 32,
  • "uniqueClicks": 51
}