Team API
API Documentation.
The API is available only to registered users with minimum Team subscription plan - API key can be generate in Team edit page
Link shortening
URL Shortener
To shorten the link with team, open the file https://cutt.ly/team/API/index.php
remotely (eg via the php file_get_contents
), and in the parameters: key enter your team API key, action specify your action, either shorten to shorten a link or stats to get link analytics. url enter the address to be shortened (it should be encoded so any special characters will be interpreted correctly), name specify the preferred shortening of the link, domain specify if you want to use your own domain, to choose your team domain to be used, enter its name.
Possible parameters
key |
Your API key. Required |
action |
Your action to perform, either shorten or stats. Required |
url |
Either your long link to be shortened or your short link to get analytics. Required |
name |
Your desired short link if not already taken |
domain |
Your desired domain to be used (only with action shorten) |
noTitle |
noTitle=1 Faster API response time This parameter disables getting the page title from the source page meta tag which results in faster API response time Available for Team Enterprise plan |
public |
public=1 Settings public click stats for shortened link via API Available from Single plan |
Examples
Errors
401 Unauthorized | Your API key is incorrect and a json with parameter auth:false has been returned |
401 Subscription has expired | Team owner's subscription has expired |
400 Incorrect action | Action is null or incorrect |
400 Url parameter is null | Parameter url was not sent |
409 Provided link is already shortened | Provided link's domain is a registered cutt.ly domain |
409 Provided link is incorrect | Provided url is not a link |
409 Provided alias contains illegal characters | Name parameter contains illegal characters |
You do not own provided domain | It occurs when you do not own the provided domain |
You do not own any domain | It occurs when you specified that you want to shorten using your own domain, but you do not own any |
Link editing
Editing short links
In order to edit short link, open the file https://cutt.ly/team/API/index.php
remotely (eg via the php file_get_contents
), with the following parameters
key |
key=[API_KEY] Your API key. Required |
action |
action=edit To initiate the link editing. Required |
url |
url=[SHORT_LINK] Your shortened link to be edited. Required |
domain |
domain=[DOMAIN] Your desired domain to be used (only with action shorten).Optional |
tag |
tag=[TAG] The TAG you want to add for shortened link. Optional |
delete |
delete=1 It will delete your shortened link. Optional |
source |
source=[FULL LINK] It will change the source url of shortened link. You can change source URL depending at your subscription plan. [FULL LINK] should be passed through urlencode(); Optional |
unique |
Sets a unique stat count for a short link.unique=0 | It removes counting unique clicks.unique=1 | for Single subscription plan. The time of uniqueness is 15 minutes.unique=15-1440 | for Team subscription plans. Time to count unique clicks ranging from 15 minutes to 1440 minutes (24h).Optional |
Status for editing short links
status => 1 | OK |
status => 2 | Could not save in database |
status => 3 | The url does not exist or you do not own it |
status => 4 (for source parameter only) | URL didn't pass the validation |
Errors
Insufficient subscription level | When using parameters without the required subscription. |
Unique time must be between 15 - 1440 minutes | Time to count unique clicks must be from 15 minutes to 1440 minutes (24h). |
Link analytics
Analytics
In order to access URL statistics, open the file https://cutt.ly/team/API/index.php
remotely (eg via the php file_get_contents
), with the following parameters:
key | Your Team API key. Required |
action | Your action to perform, either shorten or stats. Required |
url | The shortened URL you want to check statistics of. E.g. https://cutt.ly/short or https://yourdomain.com/short. Required |
date_from |
It returns the number of clicks from a given period, both total and for social media. The correct format of the given dates: YYYY-MM-DD, e.g. 2021-03-02 Can be used with the second parameter date_to or separatelyAvailable from Team subscription plan. Optional |
date_to |
It returns the number of clicks from a given period, both total and for social media. The correct format of the given dates: YYYY-MM-DD, e.g. 2021-03-02 Can be used with the second parameter date_from or separatelyAvailable from Team subscription plan. Optional |
Examples
As a reply, json string will be sent, containing following data:
stats=>status: 0 | This shortened link does not exist |
stats=>status: 1 | This link exists and the data has been downloaded |
stats=>status: 2 | Invalid API key |
If status is equal to 1
stats=>date | Date of shortening the link |
stats=>clicks | Total number of clicks |
stats=>title | Title of the shortened link |
stats=>fullLink | Original link |
stats=>shortLink | Shortened link |
stats=>facebook | The number of clicks from Facebook |
stats=>twitter | The number of clicks from twitter |
stats=>linkedin | The number of clicks from linkedin |
stats=>rest | Other clicks |
In order to display subsequent data, it should take place in a loop. (E.g. for
, while
, foreach
loop)
Let $i
to be the next variable in the array.
stats=>refs=>ref=>$i=>link | displaying the domain from which you clicked on the link |
stats=>refs=>ref=>$i=>clicks | displaying the number of clicks from that domain |
stats=>devices=>geo=>$i=>tag | displaying the abbreviation of the country from which the link was clicked |
stats=>devices=>geo=>$i=>clicks | displaying the number of clicks from this country |
stats=>devices=>dev=>$i=>tag | displaying the type of device from which the link was clicked |
stats=>devices=>dev=>$i=>clicks | displaying the number of clicks from this device |
stats=>devices=>sys=>$i=>tag | displaying the operating system of the device from which the link was clicked |
stats=>devices=>sys=>$i=>clicks | displaying the number of clicks from this system |
stats=>devices=>bro=>$i=>tag | displaying the browser from which the link was clicked |
stats=>devices=>bro=>$i=>clicks | displaying the number of clicks from this browser |
Errors
Incorrect date format | In case the date format is incorrect. The correct format of the given dates: YYYY-MM-DD, e.g. 2021-03-02 |
Insufficient subscription level | When using parameters without the required Team subscription. |