Link Shortening API Parameters

Below is the list of all possible parameters for the Link Shortening API. Required parameters are marked with Required, while optional ones are marked with Optional.

Sample Requests and Responses

                    
$url = urlencode('{{short}}');
$json = file_get_contents("https://cutt.ly/api/api.php?key={{key}}&short=$url&name={{name}}&userDomain=1");
$data = json_decode ($json, true);
var_dump($data);
                    
                

                    
public class Class1
    {
        private const string URL = "https://cutt.ly/api/api.php";
        private string urlParameters = "?key={{key}}&short={{short}}&name={{name}}&userDomain=1";

        static void Main(string[] args)
        {
            HttpClient client = new HttpClient();
            client.BaseAddress = new Uri(URL);

            // Add an Accept header for JSON format.
            client.DefaultRequestHeaders.Accept.Add(
            new MediaTypeWithQualityHeaderValue("application/json"));

            // List data response.
            HttpResponseMessage response = client.GetAsync(urlParameters).Result;  // Blocking call! Program will wait here until a response is received or a timeout occurs.
            if (response.IsSuccessStatusCode)
            {
                // Parse the response body.
                var dataObjects = response.Content.ReadAsAsync>().Result;  //Make sure to add a reference to System.Net.Http.Formatting.dll
                foreach (var d in dataObjects)
                {
                    Console.WriteLine("{0}", d.Name);
                }
            }
            else
            {
                Console.WriteLine("{0} ({1})", (int)response.StatusCode, response.ReasonPhrase);
            }

            //Make any other calls using HttpClient here.

            //Dispose once all HttpClient calls are complete. This is not necessary if the containing object will be disposed of; for example in this case the HttpClient instance will be disposed automatically when the application terminates so the following call is superfluous.
            client.Dispose();
        }
    }
                    
                

                    
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URL;

public class NetClientGet {

	public static void main(String[] args) {

	  try {

		URL url = new URL("https://cutt.ly/api/api.php?key={{key}}&short={{short}}&name={{name}}&userDomain=1");
		HttpURLConnection conn = (HttpURLConnection) url.openConnection();
		conn.setRequestMethod("GET");
		conn.setRequestProperty("Accept", "application/json");

		if (conn.getResponseCode() != 200) {
			throw new RuntimeException("Failed : HTTP error code : "
					+ conn.getResponseCode());
		}

		BufferedReader br = new BufferedReader(new InputStreamReader(
			(conn.getInputStream())));

		String output;
		System.out.println("Output from Server .... \n");
		while ((output = br.readLine()) != null) {
			System.out.println(output);
		}

		conn.disconnect();

	  } catch (MalformedURLException e) {

		e.printStackTrace();

	  } catch (IOException e) {

		e.printStackTrace();

	  }

	}

}
                    
                

                    
import urllib
import requests
key = '{{key}}'
url = urllib.parse.quote('{{short}}')
name  = '{{name}}'
userDomain = '1'
r = requests.get('http://cutt.ly/api/api.php?key={}&short={}&name={}&userDomain={}'.format(key, url, name, userDomain))
print(r.text)
                    
                

As a reply, json string will be sent, containing following data

If the status is equal to 7, then

Errors

Example 1: Shorten URL

This is the simplest example where a URL is shortened with the minimum required parameters.

Adding UTM tags, parameters, etc.
The entered URL {{short}} should go through the built-in urlencode() function, then the link parameters will be sent, including UTM tags, etc.

Example 2: Shorten URL with Custom Alias (back-half)

This example shows how to shorten a URL with a custom alias (back-half).

Adding UTM tags, parameters, etc.
The entered URL {{short}} should go through the built-in urlencode() function, then the link parameters will be sent, including UTM tags, etc.

Example 3: Shorten URL using Custom Domain

To shorten a URL using a custom domain, make a GET request to the endpoint below. You must include your API key, the URL you wish to shorten, and set the userDomain parameter to 1. Optionally, you can include other parameters such as name, noTitle, and public.

Adding UTM tags, parameters, etc.
The entered URL {{short}} should go through the built-in urlencode() function, then the link parameters will be sent, including UTM tags, etc.

Example 4: Shorten URL with Custom Alias (back-half) using Custom Domain

This example shows how to shorten a URL with a custom alias (back-half) and using a custom domain.

Adding UTM tags, parameters, etc.
The entered URL {{short}} should go through the built-in urlencode() function, then the link parameters will be sent, including UTM tags, etc.

Example 5: Shorten URL using noTitle Parameter

To shorten a URL with a faster API response time, you can use the noTitle parameter. This parameter disables getting the page title from the source page meta tag. Optionally, you can include other parameters such as name and userDomain.

Adding UTM tags, parameters, etc.
The entered URL {{short}} should go through the built-in urlencode() function, then the link parameters will be sent, including UTM tags, etc.

Example 6: Shorten URL using public Parameter

To shorten a URL and set the click stats as public via API, you can use the public parameter. Optionally, you can include other parameters such as name, noTitle, and userDomain.

Adding UTM tags, parameters, etc.
The entered URL {{short}} should go through the built-in urlencode() function, then the link parameters will be sent, including UTM tags, etc.

Example: Shorten URL with TRAI SMS Compliant Custom Domain or 2s.ms Domain

This example demonstrates how to shorten a URL using a custom domain that complies with TRAI SMS regulations.

Example: Shorten URL with Custom Alias using TRAI SMS Compliant Custom Domain or 2s.ms Domain

This example demonstrates how to shorten a URL and specify a custom alias (name) using a custom domain that complies with TRAI SMS regulations.

Editing short links | from Single plan

In order to edit short link, open the file https://cutt.ly/api/api.php remotely (eg via the php file_get_contents), with the following parameters

Below is the list of all possible parameters for the Link Editing API. Specific examples of usage are provided for each case below.

Status for editing short links

Errors

Edit a Link - Add Tag

To edit a shortened link by adding a tag, make a GET request to the endpoint below. You must include your API key, the shortened link to be edited, and the tag you want to add.

Edit a Link - Change Alias

To edit a shortened link by changing its alias, make a GET request to the endpoint below. You must include your API key, the shortened link to be edited, and the new alias you want to assign.

Edit a Link - Change Source URL

To edit a shortened link by changing its source URL, make a GET request to the endpoint below. You must include your API key, the shortened link to be edited, and the new source URL.

Edit a Link - Set Unique Clicks

To edit a shortened link by setting unique click statistics, make a GET request to the endpoint below. You must include your API key, the shortened link to be edited, and set the unique parameter.

Edit a Link - Set Unique Clicks to 1440 Minutes

To edit a shortened link by setting the unique click statistic period to 1440 minutes (24 hours), make a GET request to the endpoint below. You must include your API key, the shortened link to be edited, and set the unique parameter to 1440.

Edit a Link - Remove Unique Clicks

To edit a shortened link by removing the unique click statistic, make a GET request to the endpoint below. You must include your API key, the shortened link to be edited, and set the unique parameter to 0.

Edit a Link - Set Title

To edit a shortened link by setting the title, make a GET request to the endpoint below. You must include your API key, the shortened link to be edited, and set the title parameter to the desired title.

Edit a Link - Set Mobile Redirect

To edit a shortened link by setting mobile redirects, make a GET request to the endpoint below. You must include your API key, the shortened link to be edited, and set the mobile parameter along with the corresponding destination.

Edit a Link - Remove Mobile Redirect

To remove a mobile redirect for a shortened link, make a GET request to the endpoint below. You must include your API key, the shortened link to be edited, and set the mobile parameter to the operating system for which you want to remove the redirect.

Edit a Link - Delete Shortened Link with Specific Edit

To delete a specific shortened link, make a GET request to the endpoint below. You must include your API key, the shortened link to be edited, and set the delete parameter to 1.

Edit a Link - Set Expiration (Clicks)

To set an expiration for a shortened link based on the number of clicks, make a GET request to the endpoint below. You must include your API key, the shortened link to be edited, and configure the expiration settings using the parameters expire, expireCond, expireRedirect, and expireUnique.

Edit a Link - Set Expiration (Date)

To set an expiration for a shortened link based on a specific date, make a GET request to the endpoint below. You must include your API key, the shortened link to be edited, and configure the expiration settings using the parameters expire, expireCond, expireRedirect, and expireUnique.

Edit a Link - Remove Expiration

To remove an expiration setting from a shortened link, make a GET request to the endpoint below. You must include your API key, the shortened link to be edited, and configure the expiration settings using the parameters expire, expireCond, expireRedirect, and expireUnique.

Set Password

To set a password to a shortened link using this API, make a POST request to the endpoint below. You must include your API key, the link you want to add a password to, and set the password status to 1 in the query parameters. Provide the actual password in the request body.

In the request body, include the password using form-data as shown below:

Set AB Test

To set up an AB/C test using this API, make a GET request to the endpoint below. You must include your API key, the shortened link you want to edit, and specify the parameters for the AB/C test.

Set ABC Test

To set up an ABC test with C variation using this API, make a GET request to the endpoint below. You must include your API key, the shortened link you want to edit, and specify the parameters for the AB/C test, including the chances and URLs for both B and C variations.

AB/C Test - Remove

To remove an AB/C test from a shortened link using this API, make a GET request to the endpoint below. You must include your API key, the shortened link you want to edit, and set the abtest parameter to 0.

Analytics

In order to access URL statistics, open the file https://cutt.ly/api/api.php remotely (eg via the php file_get_contents), with the following parameters

Examples

                    
$json = file_get_contents('https://cutt.ly/api/api.php?key={{key}}&stats={{shortenedURL}}');
$data = json_decode ($json, true);
var_dump($data);
                    
                

                    
public class Class1
    {
        private const string URL = "https://cutt.ly/api/api.php";
        private string urlParameters = "?key={{key}}&stats={{shortenedURL}}";

        static void Main(string[] args)
        {
            HttpClient client = new HttpClient();
            client.BaseAddress = new Uri(URL);

            // Add an Accept header for JSON format.
            client.DefaultRequestHeaders.Accept.Add(
            new MediaTypeWithQualityHeaderValue("application/json"));

            // List data response.
            HttpResponseMessage response = client.GetAsync(urlParameters).Result;  // Blocking call! Program will wait here until a response is received or a timeout occurs.
            if (response.IsSuccessStatusCode)
            {
                // Parse the response body.
                var dataObjects = response.Content.ReadAsAsync>().Result;  //Make sure to add a reference to System.Net.Http.Formatting.dll
                foreach (var d in dataObjects)
                {
                    Console.WriteLine("{0}", d.Name);
                }
            }
            else
            {
                Console.WriteLine("{0} ({1})", (int)response.StatusCode, response.ReasonPhrase);
            }

            //Make any other calls using HttpClient here.

            //Dispose once all HttpClient calls are complete. This is not necessary if the containing object will be disposed of; for example in this case the HttpClient instance will be disposed automatically when the application terminates so the following call is superfluous.
            client.Dispose();
        }
    }
                    
                

                    
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URL;

public class NetClientGet {

	public static void main(String[] args) {

	  try {

		URL url = new URL("https://cutt.ly/api/api.php?key={{key}}&stats={{shortenedURL}}");
		HttpURLConnection conn = (HttpURLConnection) url.openConnection();
		conn.setRequestMethod("GET");
		conn.setRequestProperty("Accept", "application/json");

		if (conn.getResponseCode() != 200) {
			throw new RuntimeException("Failed : HTTP error code : "
					+ conn.getResponseCode());
		}

		BufferedReader br = new BufferedReader(new InputStreamReader(
			(conn.getInputStream())));

		String output;
		System.out.println("Output from Server .... \n");
		while ((output = br.readLine()) != null) {
			System.out.println(output);
		}

		conn.disconnect();

	  } catch (MalformedURLException e) {

		e.printStackTrace();

	  } catch (IOException e) {

		e.printStackTrace();

	  }

	}

}
                    
                

                    
import urllib
import requests
key = '{{key}}'
url = '{{shortenedURL}}'
r = requests.get('http://cutt.ly/api/api.php?key={}&stats={}'.format(key, url))
print(r.text)
                    
                

If status is equal to 1

In order to access URL statistics, open the file https://cutt.ly/api/api.php remotely (eg via the php file_get_contents), with the following parameters

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.

Errors

Analytics - Get Statistics

To retrieve the number of successful clicks for a shortened URL, make a GET request to the endpoint below. You must include your API key and the shortened URL you want to get statistics for.

Analytics - Date Range

To retrieve the number of clicks for a shortened URL within a specific date range, make a GET request to the endpoint below. You must include your API key, the shortened URL, and optionally specify the date range.

API Rate Limits

The following table outlines the API rate limits based on the selected subscription plan.