API docs by Redocly

Developer API - URLR (0.3)

Download OpenAPI specification:Download

URLR: contact@urlr.me URL: https://urlr.me/en License: All rights reserved Terms of Service

API powering the features of URLR.

Authentification

Get an access token

Request Body schema: application/json

Your credentials

username
string

Email

password
string

Password

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^[a-zA-Z0-9!-]{3,50}$

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
}

Team

Get teams of user

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "teams": [
    ]
}

Folder

Get folders of team

Authorizations:
bearerAuth
Request Body schema: application/json

Infos to provide to get folders of team

team
required
integer

Team ID (displayed on dashboard)

Responses

Request samples

Content type
application/json
{
  • "team": 123
}

Response samples

Content type
application/json
{
  • "folders": [
    ]
}