Shorten a URL

• Request
• Response
• Examples

Expand a URL

• Request
• Response
• Examples

Track a short link

• Request
• Response
• Examples

Shorten a URL

Request

To shorten a long URL, issue a GET request like this:

http://clic.gs/api/shorten?url=<url>&format=<format>&callback=<callback>

With the following values <...>:

Parameter	Required	Meaning	Possible value	Default	Comment
url	required	Long URL	http://www.reviews-web-hosting.com/	none
alias	optional	short alias	EXAMPLE	none	Alias must contain between 5 and 100 characters (letters, numbers, _ and -).
format	optional	Format of the response	xml (XML), json (Json), jsonp (JsonP) or text (plain text)	text
callback	optional	callback function for JsonP	safemn_result	missing_callback	Used with format=jsonp only

We recommend that you do not rely on the default values. You should explicitly specify the format, and the callback (for JsonP).

Response

XML:

Successful:

<?xml version="1.0" encoding="UTF-8" ?>
<data>
    <url>http://clic.gs/c</url>
</data>

Error:

<?xml version="1.0" encoding="UTF-8" ?>
<data>
    <error>Invalid URL</error>
</data>

Json:

Successful:

{ "url": "http://clic.gs/c" }

Error:

{ "error": "Invalid URL" }

JsonP (callback=safe123):

Successful:

safe123({ "url": "http://clic.gs/c" })

Error:

safe123({ "error": "Invalid URL" })

Plain text:

Successful:

http://clic.gs/c

Error:

Error: Invalid URL

Note: there might be additional white spaces (tab, space, line break) in the server reply.

Examples

Request:

http://clic.gs/api/shorten?url=http://www.aol.net/&format=jsonp&callback=safe123

Response:

safe123({ "url": "http://clic.gs/c" })

Request:

http://clic.gs/api/shorten?url=http://www.aol.net/&alias=AOL-NET&format=json

Response:

{ "url": "http://clic.gs/AOL-NET" }

Top ↑

Expand a URL

Request

To get the long URL for a short URL, issue a GET request in this fashion:

http://clic.gs/api/expand?short_url=<url>&format=<format>&callback=<callback>

With the following values <...>:

Parameter	Required	Meaning	Possible value	Default	Comment
short_url	required	Short URL	http://clic.gs/1	none
format	optional	Format of the response	xml (XML), json (Json), jsonp (JsonP) or text (plain text)	text
callback	optional	callback function for JsonP	safemn_result	missing_callback	Used with format=jsonp only

We recommend that you do not rely on the default values. You should explicitly specify the format, and the callback (for JsonP).

Response

XML:

Successful:

<?xml version="1.0" encoding="UTF-8" ?>
<data>
    <url>http://www.google.com/</url>
</data>

Error:

<?xml version="1.0" encoding="UTF-8" ?>
<data>
    <error>Invalid URL</error>
</data>

Json:

Successful:

{ "url": "http://www.google.com/" }

Error:

{ "error": "Invalid URL" }

JsonP (callback=safe123):

Successful:

safe123({ "url": "http://www.google.com/" })

Error:

safe123({ "error": "Invalid URL" })

Plain text:

Successful:

http://www.google.com/

Error:

Error: Invalid URL

Note: there might be additional white spaces (tab, space, line break) in the server reply.

Examples

Request:

http://clic.gs/api/expand?short_url=http://clic.gs/c&format=xml

Response:

<?xml version='1.0' ?>
<data>
    <url>http://www.aol.net/</url>
</data>

Top ↑

Track a short link

Request

To shorten a long URL, issue a GET request like this:

http://clic.gs/api/info?url=<url>&format=<format>&callback=<callback>

With the following values <...>:

Parameter	Required	Meaning	Possible value	Default	Comment
url	required	Long URL	http://www.reviews-web-hosting.com/	none
format	optional	Format of the response	xml (XML), json (Json), jsonp (JsonP) or text (plain text)	text
callback	optional	callback function for JsonP	safemn_result	missing_callback	Used with format=jsonp only

We recommend that you do not rely on the default values. You should explicitly specify the format, and the callback (for JsonP).

Response

json

Parameter	Meaning	Possible value	Comment
url	Long URL	http://www.reviews-web-hosting.com/
clicks	Number of clicks for the short link	1201	Integer
referers	Number of clicks per original domain	[["Direct Access/Applications","1,151"],["baidu.com","2"]]	Array of pairs [Domain, Clicks]
countries	Number of clicks per vistor country	[["United States","851"],["China","94"]]	Array of pairs [Country, Clicks]
filetype	Potentially dangerous filetype	application/x-dosexec	Empty if safe
virus	Virus name	Eicar-Test-Signature	Empty if no virus
dangerous	Known dangerous site	Spyware/Malware/Adware	Empty if safe
partial	Partial download	1	0 if download is complete
unreachable	Page is unreachable	1	0 if page is reachable
activex	Dangerous ActiveX name	00000000-0000-0000-0000-000000000000 CnBabe Adware	Empty if safe
xss	Cross-Site Scripting	1	0 if URL is safe
category	Content category	Adult	Empty if safe
redirection	Too many redirections	1	0 if not too many redirections
error	An error occurred	Invalid URL	No error field is successful
qr_short	URL of the QR code for the short link	http://safe.m/static/images/qr/1-safe.gif
qr_long	URL of the QR code for the long link	http://safe.mn/static/images/qr/1.gif

jsonp

Same as json.

xml

Root name: <data>

Parameter	Meaning	Possible value	Comment
url	Long URL	<url>http://www.reviews-web-hosting.com/</url>
clicks	Number of clicks for the short link	<clicks>1201</clicks>	Integer
referers	Number of clicks per original domain	<referers>   <referer clicks="1151" domain="Direct Access/Applications" />   <referer clicks="2" domain="baidu.com" /> </referers>	List of <referer clicks="Clicks" domain="Domain" />
countries	Number of clicks per vistor country	<countries>   <country name="United States" clicks="851" />   <country name="China" clicks="94" /> <countries>	List of <country name="Country" clicks="Clicks" />
filetype	Potentially dangerous filetype	<filetype>application/x-dosexec</filetype>	Empty if safe
virus	Virus name	<virus>Eicar-Test-Signature</virus>	Empty if no virus
dangerous	Known dangerous site	<dangerous>Spyware/Malware/Adware</dangerous>	Empty if safe
partial	Partial download	<partial>1</partial>	0 if download is complete
unreachable	Page is unreachable	<unreachable>1</unreachable>	0 if page is reachable
activex	Dangerous ActiveX name	<activex>00000000-0000-0000-0000-000000000000 CnBabe Adware</activex>	Empty if safe
xss	Cross-Site Scripting	<xss>1</xss>	0 if URL is safe
category	Content category	<category>Adult</category>	Empty if safe
redirection	Too many redirections	<redirection>1</redirection>	0 if not too many redirections
error	An error occurred	<error>Invalid URL</error>	No error field is successful
qr_short	URL of the QR code for the short link	<qr_short>http://safe.m/static/images/qr/1-safe.gif</qr_short>
qr_long	URL of the QR code for the long link	<qr_long>http://safe.mn/static/images/qr/1.gif</qr_long>

text

Fields are separated by a line break \n.

Parameter	Meaning	Possible value	Comment
url	Long URL	url: http://www.reviews-web-hosting.com/
clicks	Number of clicks for the short link	clicks: 1201	Integer
referers	Number of clicks per original domain	referers: "Direct Access/Applications": 1151 "baidu.com": 2
countries	Number of clicks per vistor country	countries: "United States": 851 "China": 94
filetype	Potentially dangerous filetype	filetype: application/x-dosexec	Empty if safe
virus	Virus name	virus: Eicar-Test-Signature	Empty if no virus
dangerous	Known dangerous site	dangerous: Spyware/Malware/Adware	Empty if safe
partial	Partial download	partial: 1	0 if download is complete
unreachable	Page is unreachable	unreachable: 1	0 if page is reachable
activex	Dangerous ActiveX name	activex: 00000000-0000-0000-0000-000000000000 CnBabe Adware	Empty if safe
xss	Cross-Site Scripting	xss: 1	0 if URL is safe
category	Content category	category: Adult	Empty if safe
redirection	Too many redirections	redirection: 1	0 if not too many redirections
error	An error occurred	error: Invalid URL	No error field is successful
qr_short	URL of the QR code for the short link	httpn://safe.m/static/images/qr/1-safe.gif
qr_long	URL of the QR code for the long link	http://safe.mn/static/images/qr/1.gif

Examples

Successful:

http://safe.mn/api/info?url=http://safe.mn/1&format=xml

<?xml version='1.0' ?>
<data>
  <activex></activex>
  <category></category>
  <clicks>1246</clicks>
  <countries>
    <country name="United States" clicks="851" />
    <country name="China" clicks="94" />
    <country name="Romania" clicks="53" />
    <country name="Russian Federation" clicks="46" />
    <country name="Japan" clicks="32" />
    <country name="Germany" clicks="24" />
    <country name="Taiwan" clicks="23" />
    <country name="Netherlands" clicks="20" />
[...]
  </countries>
  <download></download>
  <filetype></filetype>
  <google></google>
  <redirection></redirection>
  <referers>
    <referer clicks="1151" domain="Direct Access/Applications" />
    <referer clicks="73" domain="safe.mn" />
    <referer clicks="2" domain="192.168.1.75" />
    <referer clicks="2" domain="win.mail.ru" />
    <referer clicks="2" domain="baidu.com" />
    <referer clicks="1" domain="znatok.biz" />
    <referer clicks="1" domain="digifur.com" />
    <referer clicks="1" domain="www.ipark.cn" />
[...]
  </referers>
  <unreachable>0</unreachable>
  <url>http://www.amazon.com/gp/product/1430224258/ref=s9_intb_gw_i1?pf_rd_m=ATVPDKIKX0DER
&pf_rd_s=center-2&pf_rd_r=10DQS8RKGF8F4G84WJBD&pf_rd_t=101&pf_rd_p=470938631
&pf_rd_i=507846</url>
  <virus></virus>
  <xss></xss>
  <qr_short>http://safe.mn/static/images/qr/1-safe.gif</qr_short>
  <qr_long>http://safe.mn/static/images/qr/1.gif</qr_long>
</data>

Error:

http://go2.gs/api/info?url=foo&format=json

{"error":"Invalid URL"}

Top ↑