JotUrl API Documentation - Documentation

API methods

The current API version is 1.5b.

v1/

v1/expand
Given a jotURL short URL, returns the associated long URL and/or embed code.
Authentication: login
Required parameters
- login user's public API key
- short_url the JotURL short link – this parameter must be encoded
Optional parameters
- password required for password-protected URLs – this parameter must be encoded
Return values
- embed optional embed code related to short_url
- url the long URL related to short_url
Example 1 (default/json)
Request
```
https://api.joturl.com/a/v1/shorten?login={PUBLIC_KEY}&short_url=http%3A%2F%2Fjo.my%2Fjot
```
Input parameters
login = {PUBLIC_KEY}
short_url = http://jo.my/jot
Response (json)
```
{"status": {"code": 200,
    "text": "OK"},
  "result": {"url": "https://www.joturl.com/",
    "embed": ""}}
```
Example 2 (txt)
Request
```
https://api.joturl.com/a/v1/expand?format=txt&login={PUBLIC_KEY}&short_url=http%3A%2F%2Fjo.my%2Fjot
```
Input parameters
format = txt
login = {PUBLIC_KEY}
short_url = http://jo.my/jot
Response (txt)
```
status_code=200status_text=OKresult_url=https://www.joturl.com/result_embed=
```
Example 3 (plain)
Request
```
https://api.joturl.com/a/v1/expand?format=plain&login={PUBLIC_KEY}&short_url=http%3A%2F%2Fjo.my%2Fjot
```
Input parameters
format = plain
login = {PUBLIC_KEY}
short_url = http://jo.my/jot
Response (plain)
```
https://www.joturl.com/
```

v1/info

This method returns information (title, description, tag cloud, screenshot, content preview) on the destination page of a jotURL short link.

Authentication: login

Required parameters

login user's public API key
short_url the JotURL short link – this parameter must be encoded

Return values

abstracts abstract (multilanguage) of the content of the destination page (empty if not available)
descriptions description (multilanguage) meta tag of the destination page (empty if not available)
h1s NA
screenshot URL pointing to the screenshot (375px x 281px) of the destination page (empty if not available)
tags tag cloud (multilanguage) of the content of the destination page (empty if not available)
titles title (multilanguage) of the destination page (empty if not available)

Example 1 (xml)
Example 2 (txt)
Example 3 (plain)

Example 1 (xml)

Request

https://api.joturl.com/a/v1/info?format=xml&login={PUBLIC_KEY}&short_url=http%3A%2F%2Fjo.my%2Fjot

Input parameters

format	=	xml
login	=	{PUBLIC_KEY}
short_url	=	http://jo.my/jot

Response (xml)

<?xmlversion="1.0"encoding="UTF-8"?><response><status><code>200</code>  
    <text>OK</text>  
  </status>  
  <result><titles><en>Shorten URLs for free & monitor links on social networks, blogs, packaging, publications - jotURL</en>  
      <it>Per social network, blog, pubblicazioni URL corte gratuite con web monitor - jotURL</it>  
    </titles>  
    <h1s><en>The next gen TAG manager</en>  
      <it>The next gen TAG manager</it>  
    </h1s>  
    <descriptions><en>Make free short URLs and monitor links on your blog, web site, social networks, printed and digital publications, packaging.</en>  
      <it>URL corte gratis aggiornabili con web monitor per blog, siti, social network, pubblicazioni cartacee, pubblicazioni digitali e packaging.</it>  
    </descriptions>  
    <tags><en><[CDATA[<span style="font-size:1.3em;color:#b90000;">page</span> <span style="font-size:1em;">requires</span> <span style="font-size:1.3em;color:#a50000;">javascript</span> <span style="font-size:1.3em;color:#b90000;">please</span> <span style="font-size:1em;">enable</span> <span style="font-size:1.3em;color:#f50000;">your</span> <span style="font-size:1em;">browser</span> <span style="font-size:1em;">reload</span> <span style="font-size:1em;">cancel</span> <span style="font-size:1em;">ana</span> <span style="font-size:1.3em;color:#b90000;">shorten</span> <span style="font-size:1em;">urls</span> <span style="font-size:1em;">monitor</span> <span style="font-size:1.3em;color:#a50000;">links</span> <span style="font-size:1.3em;color:#a50000;">blog</span> <span style="font-size:1.3em;color:#a50000;">social</span> <span style="font-size:1.3em;color:#a50000;">networks</span> <span style="font-size:1em;">publications</span> <span style="font-size:1em;">packaging</span> <span style="font-size:1.3em;color:#b90000;">sign</span> <span style="font-size:1em;">features</span> <span style="font-size:1em;">examples</span> <span style="font-size:1.3em;color:#a50000;">business</span> <span style="font-size:1em;">pricing</span> <span style="font-size:1em;">news</span> <span style="font-size:1.3em;color:#a50000;">contacts</span> <span style="font-size:1em;">choose</span> <span style="font-size:1.3em;color:#b90000;">alias</span> <span style="font-size:1em;">needed</span> <span style="font-size:1.3em;color:#a50000;">http</span> <span style="font-size:1em;">optional</span> <span style="font-size:1.3em;color:#a50000;">least</span> <span style="font-size:1.3em;color:#a50000;">characters</span> <span style="font-size:1em;">among</span> <span style="font-size:1em;">lower</span> <span style="font-size:1em;">case</span> <span style="font-size:1em;">letters</span> <span style="font-size:1em;">numbers</span> <span style="font-size:1em;">minus</span> <span style="font-size:1em;">underscore</span> <span style="font-size:1em;">enter</span> <span style="font-size:1em;">valid</span> <span style="font-size:1em;">shortened</span> <span style="font-size:1em;">only</span> <span style="font-size:1em;">https</span> <span style="font-size:1em;">protocols</span> <span style="font-size:1em;">supported</span> <span style="font-size:1em;">must</span> <span style="font-size:1em;">wait</span> <span style="font-size:1em;">request</span> <span style="font-size:1em;">being</span> <span style="font-size:1em;">processed</span> <span style="font-size:1em;">error</span> <span style="font-size:1em;">occurred</span> <span style="font-size:1em;">while</span> <span style="font-size:1em;">loading</span> <span style="font-size:1em;">information</span> <span style="font-size:1em;">again</span> <span style="font-size:1em;">later</span> <span style="font-size:1.3em;color:#a50000;">free</span> <span style="font-size:1em;">account</span> <span style="font-size:1em;">introduced</span> <span style="font-size:1em;">briefly</span>]]></en>  
    </tags>  
    <abstracts><en><[CDATA[<span class="strong">This <span style="color:#b90000;">page</span> requires <span style="color:#a50000;">JavaScript</span> <span style="color:#b90000;">Please</span> enable <span style="color:#a50000;">JavaScript</span> in <span style="color:#f50000;">your</span> browser and reload this <span style="color:#b90000;">page</span> Ok Ok Cancel Ana Yes Sì No No en <span style="color:#b90000;">SHORTEN</span> URLS AND MONITOR <span style="color:#f50000;">YOUR</span> <span style="color:#a50000;">LINKS</span> ON <span style="color:#f50000;">YOUR</span> <span style="color:#a50000;">BLOG</span> <span style="color:#a50000;">SOCIAL</span> <span style="color:#a50000;">NETWORKS</span> [...] Only <span style="color:#a50000;">HTTP</span> or HTTPS protocols are supported The <span style="color:#b90000;">alias</span> must have at <span style="color:#a50000;">least</span> 3 <span style="color:#a50000;">characters</span> <span style="color:#b90000;">please</span> wait <span style="color:#f50000;">your</span> request is being processed &nbsp; &nbsp; An error occurred while loading information <span style="color:#b90000;">Please</span> try again later &nbsp; &nbsp; <span style="color:#b90000;">SIGN</span> UP <span style="color:#a50000;">FREE</span> ACCOUNT 3 Get introduced briefly discover jotURL 1 On <span style="color:#f50000;">your</span> <span style="color:#a50000;">blog</span> web site <span style="color:#a50000;">social</span> <span style="color:#a50000;">networks</span> … 3 For <span style="color:#f50000;">your</span> <span style="color:#a50000;">business</span> a leap forward in marketing &nbsp; jotURL on Facebook jotURL on [...] </span>]]></en>  
    </abstracts>  
    <screenshot></screenshot>  
  </result>  
</response>

Example 2 (txt)

Request

https://api.joturl.com/a/v1/info?format=txt&login={PUBLIC_KEY}&short_url=http%3A%2F%2Fjo.my%2Fjot

Input parameters

format	=	txt
login	=	{PUBLIC_KEY}
short_url	=	http://jo.my/jot

Response (txt)

status_code=200status_text=OKresult_titles_en=Shorten URLs for free & monitor links on social networks, blogs, packaging, publications - jotURLresult_titles_it=Per social network, blog, pubblicazioni URL corte gratuite con web monitor - jotURLresult_h1s_en=The next gen TAG managerresult_h1s_it=The next gen TAG managerresult_descriptions_en=Make free short URLs and monitor links on your blog, web site, social networks, printed and digital publications, packaging.result_descriptions_it=URL corte gratis aggiornabili con web monitor per blog, siti, social network, pubblicazioni cartacee, pubblicazioni digitali e packaging.result_tags_en=page requires javascript please enable your browser reload cancel ana shorten urls monitor links blog social networks publications packaging sign features examples business pricing news contacts choose alias needed http optional least characters among lower case letters numbers minus underscore enter valid shortened only https protocols supported must wait request being processed error occurred while loading information again later free account introduced brieflyresult_abstracts_en=This page requires JavaScript Please enable JavaScript in your browser and reload this page Ok Ok Cancel Ana Yes Sì No No en SHORTEN URLS AND MONITOR YOUR LINKS ON YOUR BLOG SOCIAL NETWORKS [...] Only HTTP or HTTPS protocols are supported The alias must have at least 3 characters please wait your request is being processed &nbsp; &nbsp; An error occurred while loading information Please try again later &nbsp; &nbsp; SIGN UP FREE ACCOUNT 3 Get introduced briefly discover jotURL 1 On your blog web site social networks … 3 For your business a leap forward in marketing &nbsp; jotURL on Facebook jotURL on [...]result_screenshot=

Example 3 (plain)

Request

https://api.joturl.com/a/v1/info?format=plain&login={PUBLIC_KEY}&short_url=http%3A%2F%2Fjo.my%2Fjot

Input parameters

format	=	plain
login	=	{PUBLIC_KEY}
short_url	=	http://jo.my/jot

Response (plain)

Shorten URLs for free & monitor links on social networks, blogs, packaging, publications - jotURLPer social network, blog, pubblicazioni URL corte gratuite con web monitor - jotURLThe next gen TAG managerThe next gen TAG managerMake free short URLs and monitor links on your blog, web site, social networks, printed and digital publications, packaging.URL corte gratis aggiornabili con web monitor per blog, siti, social network, pubblicazioni cartacee, pubblicazioni digitali e packaging.page requires javascript please enable your browser reload cancel ana shorten urls monitor links blog social networks publications packaging sign features examples business pricing news contacts choose alias needed http optional least characters among lower case letters numbers minus underscore enter valid shortened only https protocols supported must wait request being processed error occurred while loading information again later free account introduced brieflyThis page requires JavaScript Please enable JavaScript in your browser and reload this page Ok Ok Cancel Ana Yes Sì No No en SHORTEN URLS AND MONITOR YOUR LINKS ON YOUR BLOG SOCIAL NETWORKS [...] Only HTTP or HTTPS protocols are supported The alias must have at least 3 characters please wait your request is being processed &nbsp; &nbsp; An error occurred while loading information Please try again later &nbsp; &nbsp; SIGN UP FREE ACCOUNT 3 Get introduced briefly discover jotURL 1 On your blog web site social networks … 3 For your business a leap forward in marketing &nbsp; jotURL on Facebook jotURL on [...]

v1/limits
This method returns information on the API limits.
Authentication: key (HTTPS is mandatory)
Required parameters
- key user's private API key
- login user's public API key
Return values
- primary object containing the primary rate limit: an integer limit and the unit in which the limit is expressed. unit is one of the following [MINUTE,HOUR,DAY,3_DAY]. 3_DAY is equivalent to 3 days
- secondary object containing the secondary rate limit: an integer limit and the unit in which the limit is expressed. unit is one of the following [MINUTE,HOUR,DAY,3_DAY]. 3_DAY is equivalent to 3 days
Example 1 (xml)
Request
```
https://api.joturl.com/a/v1/limits?format=xml&login={PUBLIC_KEY}
```
Input parameters
format = xml
login = {PUBLIC_KEY}
Response (xml)
```
<?xmlversion="1.0"encoding="UTF-8"?><response><status><code>200</code>  
    <text>OK</text>  
  </status>  
  <result><primary><limit>10</limit>  
      <unit>MINUTE</unit>  
    </primary>  
    <secondary><limit>200</limit>  
      <unit>DAY</unit>  
    </secondary>  
  </result>  
</response>
```
Example 2 (txt)
Request
```
https://api.joturl.com/a/v1/limits?format=txt&login={PUBLIC_KEY}
```
Input parameters
format = txt
login = {PUBLIC_KEY}
Response (txt)
```
status_code=200status_text=OKresult_primary_limit=10result_primary_unit=MINUTEresult_secondary_limit=200result_secondary_unit=DAY
```
Example 3 (plain)
Request
```
https://api.joturl.com/a/v1/limits?format=plain&login={PUBLIC_KEY}
```
Input parameters
format = plain
login = {PUBLIC_KEY}
Response (plain)
```
10MINUTE200DAY
```
v1/shorten
Given a long URL, creates a short URL.
Authentication: key (HTTPS is mandatory)
Required parameters
- key user's private API key
- login user's public API key
- url a long URL to be shortened (e.g., http://joturl.com/) – this parameter must be encoded
Optional parameters
- alias the alias for the short URL. If not passed a random and unique alias will be generated. The alias must be at least 3 characters among lower-case letters a-z, numbers 0-9, minus -, underscore _
- domain the domain on which the short URL will be created (e.g., jo.my, uuu.my). If not passed the default domain will be used as specified in your account settings
- group the name of an existing group of URLs in which the short URL will be put – this parameter must be encoded
Return values
- long_url an echo back of the url request parameter
- short_url the created short URL
Example 1 (default/json)
Request
```
https://api.joturl.com/a/v1/shorten?login={PUBLIC_KEY}&key={PRIVATE_KEY}&alias=jot&url=https%3A%2F%2Fwww.joturl.com
```
Input parameters
login = {PUBLIC_KEY}
key = {PRIVATE_KEY}
alias = jot
url = https://www.joturl.com
Response (json)
```
{"status": {"code": 200,
    "text": "OK"},
  "result": {"short_url": "http://jo.my/jot",
    "long_url": "https://www.joturl.com"}}
```
Example 2 (xml)
Request
```
https://api.joturl.com/a/v1/shorten?format=xml&login={PUBLIC_KEY}&key={PRIVATE_KEY}&url=https%3A%2F%2Fwww.joturl.com
```
Input parameters
format = xml
login = {PUBLIC_KEY}
key = {PRIVATE_KEY}
url = https://www.joturl.com
Response (xml)
```
<?xmlversion="1.0"encoding="UTF-8"?><response><status><code>200</code>  
    <text>OK</text>  
  </status>  
  <result><short_url>http://jo.my/jot</short_url>  
    <long_url>https://www.joturl.com</long_url>  
  </result>  
</response>
```
Example 3 (plain)
Request
```
https://api.joturl.com/a/v1/shorten?format=plain&login={PUBLIC_KEY}&key={PRIVATE_KEY}&url=https%3A%2F%2Fwww.joturl.com
```
Input parameters
format = plain
login = {PUBLIC_KEY}
key = {PRIVATE_KEY}
url = https://www.joturl.com
Response (plain)
```
http://jo.my/jot
```
domains/
- v1/domains/get
  Returns the list of domains a user can use to shorten.
  Authentication: key (HTTPS is mandatory)
  Required parameters
  - key user's private API key
  - login user's public API key
  Return values
  - domains list of domains a user can use to shorten, including the default domain as defined in the user's preferences
  Example 1 (default/json)
  Request
  https://api.joturl.com/a/v1/domains/get?login={PUBLIC_KEY}&key={PRIVATE_KEY}
  Input parameters
  login = {PUBLIC_KEY}
  key = {PRIVATE_KEY}
  Response (json)
  {"status": {"code": 200, "text": "OK"}, "result": {"domains": {"d1": "jo.my", "d2": "uuu.my", "default": "jo.my"}}}
  Example 2 (txt)
  Request
  https://api.joturl.com/a/v1/domains/get?format=txt&login={PUBLIC_KEY}&key={PRIVATE_KEY}
  Input parameters
  format = txt
  login = {PUBLIC_KEY}
  key = {PRIVATE_KEY}
  Response (txt)
  status_code=200status_text=OKresult_domains_d1=jo.myresult_domains_d2=uuu.myresult_domains_default=jo.my
  Example 3 (plain)
  Request
  https://api.joturl.com/a/v1/domains/get?format=plain&login={PUBLIC_KEY}&key={PRIVATE_KEY}
  Input parameters
  format = plain
  login = {PUBLIC_KEY}
  key = {PRIVATE_KEY}
  Response (plain)
  jo.myuuu.mydefault:jo.my

groups/

v1/groups/get

Returns the list of group of URLs that are defined in the user account.

Authentication: key (HTTPS is mandatory)

Required parameters

key user's private API key
login user's public API key

Return values

groups list of group of URLs that are defined in the user account or empty. The default group of URLs is not returned

Example 1 (default/json)
Example 2 (xml)
Example 3 (txt)
Example 4 (default/json)
Example 5 (txt)
Example 6 (plain)

Example 1 (default/json)

Request

https://api.joturl.com/a/v1/groups/get?login={PUBLIC_KEY}&key={PRIVATE_KEY}

Input parameters

login	=	{PUBLIC_KEY}
key	=	{PRIVATE_KEY}

Response (json)

{"status": {"code": 200,
    "text": "OK"},
  "result": {"groups": {"g1": "group name 1",
      "g2": "group name 2",
      "g3": "group name 3"}}}

Example 2 (xml)

Request

https://api.joturl.com/a/v1/groups/get?format=xml&login={PUBLIC_KEY}&key={PRIVATE_KEY}

Input parameters

format	=	xml
login	=	{PUBLIC_KEY}
key	=	{PRIVATE_KEY}

Response (xml)

<?xmlversion="1.0"encoding="UTF-8"?><response><status><code>200</code>  
    <text>OK</text>  
  </status>  
  <result><groups><g1>group name 1</g1>  
      <g2>group name 2</g2>  
      <g3>group name 3</g3>  
    </groups>  
  </result>  
</response>

Example 3 (txt)

Request

https://api.joturl.com/a/v1/groups/get?format=txt&login={PUBLIC_KEY}&key={PRIVATE_KEY}

Input parameters

format	=	txt
login	=	{PUBLIC_KEY}
key	=	{PRIVATE_KEY}

Response (txt)

status_code=200status_text=OKresult_groups_g1=group name 1result_groups_g2=group name 2result_groups_g3=group name 3

Example 4 (default/json)

Request

https://api.joturl.com/a/v1/groups/get?login={PUBLIC_KEY}&key={PRIVATE_KEY}

Input parameters

login	=	{PUBLIC_KEY}
key	=	{PRIVATE_KEY}

Response (json)

{"status": {"code": 200,
    "text": "OK"},
  "result": {"groups": {}}}

Example 5 (txt)

Request

https://api.joturl.com/a/v1/groups/get?format=txt&login={PUBLIC_KEY}&key={PRIVATE_KEY}

Input parameters

format	=	txt
login	=	{PUBLIC_KEY}
key	=	{PRIVATE_KEY}

Response (txt)

status_code=200status_text=OKresult_groups=

Example 6 (plain)

Request

https://api.joturl.com/a/v1/groups/get?format=plain&login={PUBLIC_KEY}&key={PRIVATE_KEY}

Input parameters

format	=	plain
login	=	{PUBLIC_KEY}
key	=	{PRIVATE_KEY}

Response (plain)

urls/
- v1/urls/pwd
  Protect a short URL with a password. This method is available only to certain user profiles.
  Authentication: key (HTTPS is mandatory)
  Required parameters
  - key user's private API key
  - login user's public API key
  - short_url the JotURL short link – this parameter must be encoded
  Optional parameters
  - password define the password for the URL (max 15 chars). If empty the password will be reset – this parameter must be encoded
  Return values
  - status valid values: 0=the URL is not protected by a password, 1=the URL is protected by a password
  Example 1 (default/json)
  Request
  https://api.joturl.com/a/v1/urls/pwd?login={PUBLIC_KEY}&key={PRIVATE_KEY}&short_url=http%3A%2F%2Fjo.my%2Fjot&password=mypwd
  Input parameters
  login = {PUBLIC_KEY}
  key = {PRIVATE_KEY}
  short_url = http://jo.my/jot
  password = mypwd
  Response (json)
  {"status": {"code": 200, "text": "OK"}, "result": {"status": "1"}}
  Example 2 (default/json)
  Request
  https://api.joturl.com/a/v1/urls/pwd?login={PUBLIC_KEY}&key={PRIVATE_KEY}&short_url=http%3A%2F%2Fjo.my%2Fjot
  Input parameters
  login = {PUBLIC_KEY}
  key = {PRIVATE_KEY}
  short_url = http://jo.my/jot
  Response (json)
  {"status": {"code": 200, "text": "OK"}, "result": {"status": "0"}}
  Example 3 (default/json)
  Request
  https://api.joturl.com/a/v1/urls/pwd?login={PUBLIC_KEY}&key={PRIVATE_KEY}&short_url=http%3A%2F%2Fjo.my%2Fjot&password=
  Input parameters
  login = {PUBLIC_KEY}
  key = {PRIVATE_KEY}
  short_url = http://jo.my/jot
  password =
  Response (json)
  {"status": {"code": 200, "text": "OK"}, "result": {"status": "0"}}
- v1/urls/stats
  Get statistics for a short URL.
  Authentication: login
  Required parameters
  - login user's public API key
  - short_url the JotURL short link – this parameter must be encoded
  Return values
  - unique_visits number of unique visits from the URL creation
  - visits number of visits from the URL creation
  - Example (default/json)
  Example (default/json)
  Request
  https://api.joturl.com/a/v1/urls/stats?login={PUBLIC_KEY}&short_url=http%3A%2F%2Fjo.my%2Fjot
  Input parameters
  login = {PUBLIC_KEY}
  short_url = http://jo.my/jot
  Response (json)
  {"status": {"code": 200, "text": "OK"}, "result": {"unique_visits": "3425", "visits": "4356"}}
- v1/urls/timed
  Given a short URL, defines a validity time range. It is possible to define the start datetime, the expire datetime and the URL to be used after expiration. This method is available only to certain user profiles.
  Authentication: key (HTTPS is mandatory)
  Required parameters
  - key user's private API key
  - login user's public API key
  - short_url the JotURL short link – this parameter must be encoded
  Optional parameters
  - delete_after_expiration If 1 the short URL is scheduled to be deleted after expiration. Please note that related data will be deleted too. If delete_after_expiration = 1 parameter valid_to is mandatory.
  - expired_url URL to be used after the valid_to datetime. This parameter is ignored if valid_to is not specified or if delete_after_expiration = 1 – this parameter must be encoded
  - valid_from datetime in the format YYYY-MM-DD HH:MM (it must be in UTC time). The URL will be valid from this datetime (included). If not specified it will be considered NOW
  - valid_to datetime in the format YYYY-MM-DD HH:MM (it must be in UTC time). The URL will be valid until this datetime (excluded). If not specified it will be considered FOREVER. Time limits are removed if both valid_from and valid_to are not specified (a off status will be returned).
  Return values
  - status valid values: off=no timing defined (no time range), on play=timing defined, the URL is active (i.e., current time is between valid_from and valid_to, including valid_from excluding valid_to), on pause=timing defined, the URL is paused (i.e., current time is lower than valid_from), on stop=timing defined, the URL is stopped (i.e., current time is higher or equal to valid_to)
  Example 1 (default/json)
  Request
  https://api.joturl.com/a/v1/urls/timed?login={PUBLIC_KEY}&key={PRIVATE_KEY}&short_url=http%3A%2F%2Fjo.my%2Fjot&from=2023-01-21+00%3A00&to=2023-02-10+23%3A59
  Input parameters
  login = {PUBLIC_KEY}
  key = {PRIVATE_KEY}
  short_url = http://jo.my/jot
  from = 2023-01-21 00:00
  to = 2023-02-10 23:59
  Response (json)
  {"status": {"code": 200, "text": "OK"}, "result": {"status": "on play"}}
  Example 2 (default/json)
  Request
  https://api.joturl.com/a/v1/urls/timed?login={PUBLIC_KEY}&key={PRIVATE_KEY}&short_url=http%3A%2F%2Fjo.my%2Fjot&from=2023-02-10+00%3A00&to=2023-02-20+23%3A59
  Input parameters
  login = {PUBLIC_KEY}
  key = {PRIVATE_KEY}
  short_url = http://jo.my/jot
  from = 2023-02-10 00:00
  to = 2023-02-20 23:59
  Response (json)
  {"status": {"code": 200, "text": "OK"}, "result": {"status": "on pause"}}
  Example 3 (default/json)
  Request
  https://api.joturl.com/a/v1/urls/timed?login={PUBLIC_KEY}&key={PRIVATE_KEY}&short_url=http%3A%2F%2Fjo.my%2Fjot&from=2023-01-11+00%3A00&to=2023-01-21+23%3A59
  Input parameters
  login = {PUBLIC_KEY}
  key = {PRIVATE_KEY}
  short_url = http://jo.my/jot
  from = 2023-01-11 00:00
  to = 2023-01-21 23:59
  Response (json)
  {"status": {"code": 200, "text": "OK"}, "result": {"status": "on stop"}}
  Example 4 (default/json)
  Request
  https://api.joturl.com/a/v1/urls/timed?login={PUBLIC_KEY}&key={PRIVATE_KEY}&short_url=http%3A%2F%2Fjo.my%2Fjot&from=&to=
  Input parameters
  login = {PUBLIC_KEY}
  key = {PRIVATE_KEY}
  short_url = http://jo.my/jot
  from =
  to =
  Response (json)
  {"status": {"code": 200, "text": "OK"}, "result": {"status": "off"}}
- hub/
  - v1/urls/hub/add
    Creates a URL hub if it does not exist and adds the specified short URL to it. If the hub was previously created, this methods adds the specified short URL to the hub. This method is available only to certain user profiles.
    Authentication: key (HTTPS is mandatory)
    Required parameters
    - condition the condition to be associated to the short_url. If the condition is met the hub is redirected to short_url. A complete reference on this parameter can be found on your dashboard – this parameter must be encoded
    - controller the short URL that will be used if none of the conditions in the hub are met – this parameter must be encoded
    - key user's private API key
    - login user's public API key
    - short_url the JotURL short link to be added – this parameter must be encoded
    Return values
    - result valid values: 0=an error occurred, 1=the method completed successfully
    Example (default/json)
    Example (default/json)
    Request
    https://api.joturl.com/a/v1/urls/hub/add?login={PUBLIC_KEY}&key={PRIVATE_KEY}&controller=http%3A%2F%2Fjo.my%2Fhub&short_url=http%3A%2F%2Fjo.my%2Fjot&condition=%23visits%23+%3C+10
    Input parameters
    login = {PUBLIC_KEY}
    key = {PRIVATE_KEY}
    controller = http://jo.my/hub
    short_url = http://jo.my/jot
    condition = #visits# < 10
    Response (json)
    {"status": {"code": 200, "text": "OK"}, "result": 1}
  - v1/urls/hub/delete
    Delete a URL hub. This method is available only to certain user profiles.
    Authentication: key (HTTPS is mandatory)
    Required parameters
    - controller the short URL that identifies the URL hub – this parameter must be encoded
    - key user's private API key
    - login user's public API key
    Return values
    - result valid values: 0=an error occurred, 1=the method completed successfully
    Example 1 (default/json)
    Example 2 (default/json)
    Example 1 (default/json)
    Request
    https://api.joturl.com/a/v1/urls/hub/delete?login={PUBLIC_KEY}&key={PRIVATE_KEY}&controller=http%3A%2F%2Fjo.my%2Fhub
    Input parameters
    login = {PUBLIC_KEY}
    key = {PRIVATE_KEY}
    controller = http://jo.my/hub
    Response (json)
    {"status": {"code": 200, "text": "OK"}, "result": 1}
    Example 2 (default/json)
    Request
    https://api.joturl.com/a/v1/urls/hub/delete?login={PUBLIC_KEY}&key={PRIVATE_KEY}&controller=http%3A%2F%2Fjo.my%2Fhub
    Input parameters
    login = {PUBLIC_KEY}
    key = {PRIVATE_KEY}
    controller = http://jo.my/hub
    Response (json)
    {"status": {"code": 200, "text": "OK"}, "result": 0}
  - v1/urls/hub/remove
    Remove a short URL from a URL hub. If you remove the last short URL in the hub, the hub is automatically deleted. This method is available only to certain user profiles.
    Authentication: key (HTTPS is mandatory)
    Required parameters
    - controller the short URL that identifies the URL hub – this parameter must be encoded
    - key user's private API key
    - login user's public API key
    - short_url the JotURL short link to be removed – this parameter must be encoded
    Return values
    - result valid values: 0=an error occurred, 1=the method completed successfully
    Example 1 (default/json)
    Example 2 (default/json)
    Example 1 (default/json)
    Request
    https://api.joturl.com/a/v1/urls/hub/remove?login={PUBLIC_KEY}&key={PRIVATE_KEY}&controller=http%3A%2F%2Fjo.my%2Fhub&short_url=http%3A%2F%2Fjo.my%2Fjot
    Input parameters
    login = {PUBLIC_KEY}
    key = {PRIVATE_KEY}
    controller = http://jo.my/hub
    short_url = http://jo.my/jot
    Response (json)
    {"status": {"code": 200, "text": "OK"}, "result": 1}
    Example 2 (default/json)
    Request
    https://api.joturl.com/a/v1/urls/hub/remove?login={PUBLIC_KEY}&key={PRIVATE_KEY}&controller=http%3A%2F%2Fjo.my%2Fhub&short_url=http%3A%2F%2Fjo.my%2Fjot
    Input parameters
    login = {PUBLIC_KEY}
    key = {PRIVATE_KEY}
    controller = http://jo.my/hub
    short_url = http://jo.my/jot
    Response (json)
    {"status": {"code": 200, "text": "OK"}, "result": 0}
- timed/
  - v1/urls/timed/expand
    Returns information on the validity range of a given short URL. This method is available only to certain user profiles.
    Authentication: key (HTTPS is mandatory)
    Required parameters
    - key user's private API key
    - login user's public API key
    - short_url the JotURL short link – this parameter must be encoded
    Return values
    - delete_after_expiration NA
    - expired_url NA
    - status NA
    - valid_from NA
    - valid_to NA
    Example (default/json)
    Example (default/json)
    Request
    https://api.joturl.com/a/v1/urls/timed/expand?login={PUBLIC_KEY}&key={PRIVATE_KEY}&short_url=http%3A%2F%2Fjo.my%2Fjot
    Input parameters
    login = {PUBLIC_KEY}
    key = {PRIVATE_KEY}
    short_url = http://jo.my/jot
    Response (json)
    {"status": {"code": 200, "text": "OK"}, "result": {"status": "on play"}}

API methods

v1/

v1/expand

Required parameters

Optional parameters

Return values

Example 1 (default/json)

Request

Input parameters

Response (json)

Example 2 (txt)

Request

Input parameters

Response (txt)

Example 3 (plain)

Request

Input parameters

Response (plain)

v1/info

Required parameters

Return values

Example 1 (xml)

Request

Input parameters

Response (xml)

Example 2 (txt)

Request

Input parameters

Response (txt)

Example 3 (plain)

Request

Input parameters

Response (plain)

v1/limits

Required parameters

Return values

Example 1 (xml)

Request

Input parameters

Response (xml)

Example 2 (txt)

Request

Input parameters

Response (txt)

Example 3 (plain)

Request

Input parameters

Response (plain)

v1/shorten

Required parameters

Optional parameters

Return values

Example 1 (default/json)

Request

Input parameters

Response (json)

Example 2 (xml)

Request

Input parameters

Response (xml)

Example 3 (plain)

Request

Input parameters

Response (plain)

domains/

v1/domains/get

Required parameters

Return values

Example 1 (default/json)

Request

Input parameters

Response (json)

Example 2 (txt)

Request

Input parameters

Response (txt)

Example 3 (plain)

Request

Input parameters

Response (plain)