Tools

Introduction

The Tools API provides public utilities that can be used without authentication. These endpoints are designed to be quick, easy-to-use functions that enhance the user experience with the link shortener service.

The two available endpoints are:

• Check Short URL: This endpoint allows you to retrieve the original destination URL from a shortened link.
• UTM Builder: This tool helps you construct URLs with UTM parameters for better tracking in your campaigns.

Check Short URL

Description: Retrieves the original destination of a shortened URL.

• Method: POST
• Endpoint: /tools/check
• Body Parameters:
  • url (string, required): The shortened URL to check.

Example Request

POST /tools/check
Content-Type: application/json
Accept: application/json

{
    "url": "https://cutr.it/abc123"
}

Example Response

HTTP Status Code: 200
Content-Type: application/json

{
    "destination_link": "https://example-1.com"
}

UTM Builder

Description: Builds a URL with UTM parameters.

• Method: POST
• Endpoint: /tools/utm
• Body Parameters:
  • url (string, required): The base URL.
  • utm_source (string, required): UTM source.
  • utm_medium (string, optional): UTM medium.
  • utm_campaign (string, optional): UTM campaign.
  • utm_term (string, optional): UTM term.
  • utm_content (string, optional): UTM content.

Example Request

POST /tools/utm
Content-Type: application/json
Accept: application/json

{
    "url": "https://example.com",
    "utm_source": "google",
    "utm_medium": "social",
    "utm_campaign": "sale",
    "utm_term": "keywords",
    "utm_content": "buy-now"
}

Example Response

HTTP Status Code: 200
Content-Type: application/json

{
    "data": "https://example.com?utm_source=google&utm_medium=social&utm_campaign=sale&utm_term=keywords&utm_content=buy-now"
}