T.LY API

Create and update short links, customize QR codes, and track short links and OneLinks from your own code. Send requests over HTTPS with an API token from your account. Responses are JSON unless you request plain text or a QR code image.

Base URL https://api.t.ly

Get an API token Browse endpoints

Create your first short link

curl -X POST https://api.t.ly/api/v1/link/shorten \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"long_url": "https://example.com/"}'

const response = await fetch("https://api.t.ly/api/v1/link/shorten", {
    method: "POST",
    headers: {
        "Authorization": "Bearer YOUR_API_TOKEN",
        "Content-Type": "application/json",
    },
    body: JSON.stringify({ long_url: "https://example.com/" }),
});
const link = await response.json();
console.log(link.short_url);

$client = new \GuzzleHttp\Client();
$response = $client->post('https://api.t.ly/api/v1/link/shorten', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_TOKEN'],
    'json' => ['long_url' => 'https://example.com/'],
]);
$link = json_decode((string) $response->getBody(), true);
echo $link['short_url'];

import requests

response = requests.post(
    "https://api.t.ly/api/v1/link/shorten",
    headers={"Authorization": "Bearer YOUR_API_TOKEN"},
    json={"long_url": "https://example.com/"},
)
print(response.json()["short_url"])

200 OK

{
    "short_url": "https://t.ly/c55j",
    "long_url": "https://example.com/",
    "domain": "https://t.ly/",
    "short_id": "c55j",
    "public_stats": false
}

Quick start

Create a token

Open Settings › API and create a token. Keep it secret, like a password.
Send it with every request

Add an Authorization: Bearer YOUR_API_TOKEN header.
Shorten a link

Send a long_url to Create a short link and you get the short URL back.

API reference

Short links 11 endpoints Create, find, update and delete short links, one at a time or in bulk, and get each link's stats.
QR codes 2 endpoints Download a short link's QR code, or change its colors, style and logo.
OneLinks 2 endpoints List your OneLink pages and get their visits and button clicks.
Team analytics 10 endpoints Report on visits, top links and traffic sources across your team, or page through individual visits and QR scans.
Tags 5 endpoints The tags you use to organize links.
Pixels 5 endpoints Retargeting pixels that fire when someone visits a link.
UTM presets 5 endpoints Saved sets of UTM parameters to add to long URLs.
Account and usage 3 endpoints Check your token's account, find team members and monitor plan allowances.
Domains 1 endpoint Find your team's branded domain URLs for link creation and filters.
Webhooks 8 endpoints For most integrations, configure webhooks in Settings and receive events in your app. These optional endpoints automate subscription and delivery management.

Authentication

Send your API token in the Authorization header as Bearer YOUR_API_TOKEN. Requests without a valid token get a 401.

Each API token is tied to a team. Links you create belong to that team. Create and revoke tokens in Settings › API.

Use Get the current user to see which user is associated with your token.

Rate limits and errors

These limits apply per user and are shared across that user's API tokens. Each row has a separate counter. Requests in one row do not use another row's allowance.

Requests per minute with an API token
Requests	Per minute
Create a short link	1,000
Other API endpoints	500

Listing links, bulk requests, analytics, QR codes and the other endpoints in this reference share the general counter.

Monthly link allowance

Your plan also limits how many links your team can create each month. This is separate from the per-minute limits above. Every link counts, whether a teammate made it in the app or through the API.

If you reach it, waiting a minute won't help. Upgrade your plan, or wait until the 1st of next month when it resets. See your limit in Settings › Subscription.

Use Get team usage to check monthly usage, reset dates and plan allowances in one request.

When to retry

For a temporary 429, wait at least the number of seconds in Retry-After. If it is missing, use exponential backoff with jitter and stop after a few attempts. If message says the monthly allowance was reached, stop retrying until the allowance changes.

Successful responses include X-RateLimit-Limit and X-RateLimit-Remaining for the request's group. A throttled response also includes X-RateLimit-Reset, a Unix timestamp, and Retry-After.

Error responses

Error status codes
Status	Meaning
`401`	The token is missing or invalid.
`402`	Your team needs an active subscription.
`403`	Your plan doesn't include this, or the request was blocked.
`404`	The link or item wasn't found.
`409`	The webhook is disabled. Enable it before resending a delivery.
`410`	The short link is disabled.
`422`	A field or product rule rejected the request. Check `message` and, when present, `errors`.
`429`	Check `message`: a rate limit or your monthly link allowance was reached. Honor `Retry-After` when present.
`503`	The visit-log query timed out. Retry with a shorter date range.

API errors and safe retries

More ways to connect

Short links

Create, find, update and delete short links, one at a time or in bulk, and get each link's stats.

Create a short link

POST https://api.t.ly/api/v1/link/shorten

Shortens a long URL. You can also set a custom ending, an expiry, a password, tags and pixels, and add Smart URLs or A/B rotation in the same call.

1,000/minute per user Needs an API token

Request

curl -X POST https://api.t.ly/api/v1/link/shorten \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "long_url": "https://example.com/",
    "domain": "https://t.ly/",
    "description": "Social Media Link",
    "expire_at_datetime": "2035-01-17 15:00:00",
    "public_stats": true,
    "meta": {
        "expiration_url": "https://example.com/expired",
        "smart_urls": [
            {
                "conditions": [
                    "US",
                    "Android"
                ],
                "url": "https://example.com/us-android"
            }
        ]
    }
}'

const url = new URL(
    "https://api.t.ly/api/v1/link/shorten"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "long_url": "https:\/\/example.com\/",
    "domain": "https:\/\/t.ly\/",
    "description": "Social Media Link",
    "expire_at_datetime": "2035-01-17 15:00:00",
    "public_stats": true,
    "meta": {
        "expiration_url": "https:\/\/example.com\/expired",
        "smart_urls": [
            {
                "conditions": [
                    "US",
                    "Android"
                ],
                "url": "https:\/\/example.com\/us-android"
            }
        ]
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/link/shorten';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'long_url' => 'https://example.com/',
            'domain' => 'https://t.ly/',
            'description' => 'Social Media Link',
            'expire_at_datetime' => '2035-01-17 15:00:00',
            'public_stats' => true,
            'meta' => [
                'expiration_url' => 'https://example.com/expired',
                'smart_urls' => [
                    [
                        'conditions' => [
                            'US',
                            'Android',
                        ],
                        'url' => 'https://example.com/us-android',
                    ],
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/link/shorten'
payload = {
    "long_url": "https:\/\/example.com\/",
    "domain": "https:\/\/t.ly\/",
    "description": "Social Media Link",
    "expire_at_datetime": "2035-01-17 15:00:00",
    "public_stats": true,
    "meta": {
        "expiration_url": "https:\/\/example.com\/expired",
        "smart_urls": [
            {
                "conditions": [
                    "US",
                    "Android"
                ],
                "url": "https:\/\/example.com\/us-android"
            }
        ]
    }
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Send a real request with your own token.

Try Create a short link

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

Body JSON

Response

{
    "short_url": "https://t.ly/c55j",
    "description": "Social Media Link",
    "long_url": "https://example.com/",
    "domain": "https://t.ly/",
    "short_id": "c55j",
    "expire_at_views": null,
    "expire_at_datetime": "2035-01-17 15:00:00",
    "public_stats": true,
    "created_at": "2026-11-07T12:00:00.000000Z",
    "updated_at": "2026-11-07T12:00:00.000000Z",
    "meta": {
        "expiration_url": "https://example.com/expired",
        "smart_urls": [
            {
                "conditions": [
                    "US",
                    "Android"
                ],
                "url": "https://example.com/us-android"
            }
        ],
        "rotation_urls": []
    }
}

Body parameters

long_url string Required

The page the short link sends visitors to.

Example: https://example.com/
domain string

The domain for the short link: https://t.ly/ or one of your custom domains.

Example: https://t.ly/
short_id string

The ending after the domain, like fall-sale. Leave it out for a random one.
description string

A private note to help you find the link later, up to 200 characters.

Example: Social Media Link
expire_at_datetime string

When the link stops working, in UTC. Use YYYY-MM-DD HH:mm:ss.

Example: 2035-01-17 15:00:00
expire_at_views integer

Stop working after this many visits. Integer from 1 to 100000.
password string

Visitors must enter this password before they are sent on. Use 5 to 100 characters.
public_stats boolean

Let anyone see the link's stats.

Example: true
tags array of integers

IDs of tags to add to the link. See List tags.
pixels array of integers

IDs of retargeting pixels to add to the link. See List pixels.
meta object

An expiration URL, Smart URLs or rotation URLs for A/B tests. Smart URLs and rotation URLs can't be used together; sending both returns a 422. Rotation URLs are the full set of A/B destinations, so include long_url if it should be one of them. A Smart URL can set a single type, or several conditions that must all match. See the Smart URL options.

Example: {"expiration_url":"https://example.com/expired","smart_urls":[{"conditions":["US","Android"],"url":"https://example.com/us-android"}]}
include_qr_code boolean

Also return the link's QR code as qr_code_url and qr_code_base64.
format string

text returns only the short URL as plain text.

One of jsontext

List short links

GET https://api.t.ly/api/v1/link/list

Returns your team's short links, newest first, 15 to a page unless you set limit. Send both start_date and end_date to filter by creation time; a single bound is ignored. Dates without times mean midnight UTC, so use an end-of-day timestamp to include the whole final day.

500/minute · Shared general limit Needs an API token

Request

curl -X GET 'https://api.t.ly/api/v1/link/list?search=amazon&tag_ids%5B0%5D=1&tag_ids%5B1%5D=2&tag_ids%5B2%5D=3&pixel_ids%5B0%5D=1&pixel_ids%5B1%5D=2&pixel_ids%5B2%5D=3&start_date=2026-01-01&end_date=2026-12-31T23%3A59%3A59Z&domains%5B0%5D=https%3A%2F%2Ft.ly%2F&user_ids%5B0%5D=1&limit=15&page=1' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/link/list"
);

const params = {
    "search": "amazon",
    "tag_ids[0]": "1",
    "tag_ids[1]": "2",
    "tag_ids[2]": "3",
    "pixel_ids[0]": "1",
    "pixel_ids[1]": "2",
    "pixel_ids[2]": "3",
    "start_date": "2026-01-01",
    "end_date": "2026-12-31T23:59:59Z",
    "domains[0]": "https://t.ly/",
    "user_ids[0]": "1",
    "limit": "15",
    "page": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/link/list';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
            'Content-Type' => 'application/json',
        ],
        'query' => [
            'search' => 'amazon',
            'tag_ids[0]' => '1',
            'tag_ids[1]' => '2',
            'tag_ids[2]' => '3',
            'pixel_ids[0]' => '1',
            'pixel_ids[1]' => '2',
            'pixel_ids[2]' => '3',
            'start_date' => '2026-01-01',
            'end_date' => '2026-12-31T23:59:59Z',
            'domains[0]' => 'https://t.ly/',
            'user_ids[0]' => '1',
            'limit' => '15',
            'page' => '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/link/list'
params = {
  'search': 'amazon',
  'tag_ids[0]': '1',
  'tag_ids[1]': '2',
  'tag_ids[2]': '3',
  'pixel_ids[0]': '1',
  'pixel_ids[1]': '2',
  'pixel_ids[2]': '3',
  'start_date': '2026-01-01',
  'end_date': '2026-12-31T23:59:59Z',
  'domains[0]': 'https://t.ly/',
  'user_ids[0]': '1',
  'limit': '15',
  'page': '1',
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Send a real request with your own token.

Try List short links

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

search

tag_ids comma-separated

pixel_ids comma-separated

start_date

end_date

domains comma-separated

user_ids comma-separated

limit

page

Response

{
    "current_page": 1,
    "data": [
        {
            "short_url": "https://t.ly/1234",
            "description": "Amazon campaign",
            "long_url": "https://example.com/amazon",
            "domain": "https://t.ly/",
            "short_id": "1234",
            "expire_at_datetime": null,
            "expire_at_views": null,
            "public_stats": false,
            "meta": {
                "smart_urls": []
            },
            "created_at": "2026-11-01T13:24:52.000000Z",
            "updated_at": "2026-11-01T13:24:52.000000Z",
            "has_password": false,
            "tags": [
                {
                    "id": 1,
                    "tag": "campaign"
                }
            ],
            "pixels": [
                {
                    "id": 1,
                    "name": "Campaign pixel",
                    "pixel_type": "googleTagManager",
                    "pixel_id": "GTM-ABC1234"
                }
            ]
        }
    ],
    "per_page": 15,
    "total": 1
}

Query parameters

search string

Only links whose URL, ending or description contains this text.

Example: amazon
tag_ids array of integers

Only links with any of these tag IDs. Up to 10.

Example: [1,2,3]
pixel_ids array of integers

Only links with any of these pixel IDs. Up to 10.

Example: [1,2,3]
start_date string

Only links created on or after this UTC timestamp. Requires end_date.

Example: 2026-01-01
end_date string

Only links created on or before this UTC timestamp. Requires start_date.

Example: 2026-12-31T23:59:59Z
domains array of strings

Only links on these domain URLs, including scheme and trailing slash. Up to 10.

Example: ["https://t.ly/"]
user_ids array of integers

Only links created by these team members (user IDs). Up to 10.

Example: [1]
limit integer

Links per page, from 1 to 5000. Defaults to 15.

Example: 15
page integer

Page number, starting at 1.

Example: 1

Expand a short link

POST https://api.t.ly/api/v1/link/expand

Returns the long URL a short link points to. A successful expansion can record a visit, or a QR scan when is_qr_code is true, subject to analytics tracking rules. To inspect a link you own without recording a visit, use Get a short link.

500/minute · Shared general limit Needs an API token

Request

curl -X POST https://api.t.ly/api/v1/link/expand \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "short_url": "https://t.ly/c55j",
    "is_qr_code": false,
    "password": "password123"
}'

const url = new URL(
    "https://api.t.ly/api/v1/link/expand"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "short_url": "https:\/\/t.ly\/c55j",
    "is_qr_code": false,
    "password": "password123"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/link/expand';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'short_url' => 'https://t.ly/c55j',
            'is_qr_code' => false,
            'password' => 'password123',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/link/expand'
payload = {
    "short_url": "https:\/\/t.ly\/c55j",
    "is_qr_code": false,
    "password": "password123"
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Send a real request with your own token.

Try Expand a short link

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

Body JSON

Response

{
    "long_url": "https://example.com/",
    "expired": false
}

Body parameters

short_url string Required

The short link to expand.

Example: https://t.ly/c55j
is_qr_code boolean

Count this as a QR code scan.

Example: false
password string

The link's password, if it has one.

Example: password123

Bulk shorten links

POST https://api.t.ly/api/v1/link/bulk

Creates up to 100,000 short links in the background. Send return_job: true to receive a job ID and progress URLs with HTTP 202. Poll the status URL every 3–5 seconds until completed, completed_with_errors, or failed, then retrieve any failed rows. Without return_job, the response stays HTTP 200 with true. Completion emails are sent after all rows finish.

500/minute · Shared general limit Needs an API token

Request

curl -X POST https://api.t.ly/api/v1/link/bulk \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "domain": "https://t.ly/",
    "links": [
        {
            "LongUrl": "https://google.com/",
            "Backhalf": "123",
            "Password": "password123",
            "Description": "Short link description"
        }
    ],
    "tags": [
        1,
        2,
        3
    ],
    "pixels": [
        1,
        2,
        3
    ],
    "return_job": true
}'

const url = new URL(
    "https://api.t.ly/api/v1/link/bulk"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "domain": "https:\/\/t.ly\/",
    "links": [
        {
            "LongUrl": "https:\/\/google.com\/",
            "Backhalf": "123",
            "Password": "password123",
            "Description": "Short link description"
        }
    ],
    "tags": [
        1,
        2,
        3
    ],
    "pixels": [
        1,
        2,
        3
    ],
    "return_job": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/link/bulk';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'domain' => 'https://t.ly/',
            'links' => [
                [
                    'LongUrl' => 'https://google.com/',
                    'Backhalf' => '123',
                    'Password' => 'password123',
                    'Description' => 'Short link description',
                ],
            ],
            'tags' => [
                1,
                2,
                3,
            ],
            'pixels' => [
                1,
                2,
                3,
            ],
            'return_job' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/link/bulk'
payload = {
    "domain": "https:\/\/t.ly\/",
    "links": [
        {
            "LongUrl": "https:\/\/google.com\/",
            "Backhalf": "123",
            "Password": "password123",
            "Description": "Short link description"
        }
    ],
    "tags": [
        1,
        2,
        3
    ],
    "pixels": [
        1,
        2,
        3
    ],
    "return_job": true
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Send a real request with your own token.

Try Bulk shorten links

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

Body JSON

Response

{
    "job_id": "7f9874ce-7bd5-4e62-a1ed-3ffb35187358",
    "operation": "import",
    "status": "queued",
    "total_count": 1,
    "processed_count": 0,
    "success_count": 0,
    "failed_count": 0,
    "skipped_count": 0,
    "progress": 0,
    "created_at": "2026-11-07T12:00:00.000000Z",
    "started_at": null,
    "completed_at": null,
    "status_url": "https://api.t.ly/api/v1/link/bulk/7f9874ce-7bd5-4e62-a1ed-3ffb35187358",
    "failures_url": "https://api.t.ly/api/v1/link/bulk/7f9874ce-7bd5-4e62-a1ed-3ffb35187358/failures",
    "download_failed_rows_url": null
}

true

Body parameters

domain string Required

The domain for the new links: https://t.ly/ or one of your custom domains.

Example: https://t.ly/
links array of objects Required

The links to create. Each has a LongUrl, and can have a Backhalf, Password and Description.

Example: [{"LongUrl":"https://google.com/","Backhalf":"123","Password":"password123","Description":"Short link description"}]
tags array of integers

Tag IDs to add to every link.

Example: [1,2,3]
pixels array of integers

Pixel IDs to add to every link.

Example: [1,2,3]
return_job boolean

Return a job ID and progress URLs. Omit or set false to keep the original true response.

Example: true

Bulk update links

POST https://api.t.ly/api/v1/link/bulk/update

Updates up to 100,000 links in the background. Leave a field out or blank to keep its current value. Send return_job: true to receive a job ID and progress URLs with HTTP 202. Poll the status URL every 3–5 seconds until completed, completed_with_errors, or failed, then retrieve any failed rows. Without return_job, the response stays HTTP 200 with true. Completion emails are sent after all rows finish.

500/minute · Shared general limit Needs an API token

Request

curl -X POST https://api.t.ly/api/v1/link/bulk/update \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "links": [
        {
            "ShortURL": "https://t.ly/123",
            "LongURL": "https://google.com/",
            "Backhalf": "new",
            "Password": "password123",
            "Description": "Short link description"
        }
    ],
    "tags": [
        1,
        2,
        3
    ],
    "pixels": [
        1,
        2,
        3
    ],
    "return_job": true
}'

const url = new URL(
    "https://api.t.ly/api/v1/link/bulk/update"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "links": [
        {
            "ShortURL": "https:\/\/t.ly\/123",
            "LongURL": "https:\/\/google.com\/",
            "Backhalf": "new",
            "Password": "password123",
            "Description": "Short link description"
        }
    ],
    "tags": [
        1,
        2,
        3
    ],
    "pixels": [
        1,
        2,
        3
    ],
    "return_job": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/link/bulk/update';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'links' => [
                [
                    'ShortURL' => 'https://t.ly/123',
                    'LongURL' => 'https://google.com/',
                    'Backhalf' => 'new',
                    'Password' => 'password123',
                    'Description' => 'Short link description',
                ],
            ],
            'tags' => [
                1,
                2,
                3,
            ],
            'pixels' => [
                1,
                2,
                3,
            ],
            'return_job' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/link/bulk/update'
payload = {
    "links": [
        {
            "ShortURL": "https:\/\/t.ly\/123",
            "LongURL": "https:\/\/google.com\/",
            "Backhalf": "new",
            "Password": "password123",
            "Description": "Short link description"
        }
    ],
    "tags": [
        1,
        2,
        3
    ],
    "pixels": [
        1,
        2,
        3
    ],
    "return_job": true
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Send a real request with your own token.

Try Bulk update links

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

Body JSON

Response

{
    "job_id": "7f9874ce-7bd5-4e62-a1ed-3ffb35187358",
    "operation": "update",
    "status": "queued",
    "total_count": 1,
    "processed_count": 0,
    "success_count": 0,
    "failed_count": 0,
    "skipped_count": 0,
    "progress": 0,
    "created_at": "2026-11-07T12:00:00.000000Z",
    "started_at": null,
    "completed_at": null,
    "status_url": "https://api.t.ly/api/v1/link/bulk/7f9874ce-7bd5-4e62-a1ed-3ffb35187358",
    "failures_url": "https://api.t.ly/api/v1/link/bulk/7f9874ce-7bd5-4e62-a1ed-3ffb35187358/failures",
    "download_failed_rows_url": null
}

true

Body parameters

links array of objects Required

The links to update. Each needs a ShortURL, and can set LongURL, Backhalf, Password and Description.

Example: [{"ShortURL":"https://t.ly/123","LongURL":"https://google.com/","Backhalf":"new","Password":"password123","Description":"Short link description"}]
tags array of integers

Up to 10 tag IDs. A non-empty list replaces the tags on every link. Omit or send an empty array to keep current tags.

Example: [1,2,3]
pixels array of integers

Up to 10 pixel IDs. A non-empty list replaces the pixels on every link. Omit or send an empty array to keep current pixels.

Example: [1,2,3]
return_job boolean

Return a job ID and progress URLs. Omit or set false to keep the original true response.

Example: true

Get a short link

GET https://api.t.ly/api/v1/link

Returns one short link, with its tags, pixels and QR code.

500/minute · Shared general limit Needs an API token

Request

curl -X GET 'https://api.t.ly/api/v1/link?short_url=https%3A%2F%2Ft.ly%2Fc55j' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/link"
);

const params = {
    "short_url": "https://t.ly/c55j",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/link';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
            'Content-Type' => 'application/json',
        ],
        'query' => [
            'short_url' => 'https://t.ly/c55j',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/link'
params = {
  'short_url': 'https://t.ly/c55j',
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Send a real request with your own token.

Try Get a short link

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

short_url

Response

{
    "short_url": "https://t.ly/c55j",
    "long_url": "https://weatherextension.com/",
    "domain": "https://t.ly/",
    "short_id": "c55j",
    "expire_at_views": null,
    "expire_at_datetime": null,
    "public_stats": false,
    "qr_code_url": "https://api.t.ly/api/v1/link/qr-code?short_url=https://t.ly/c55j",
    "qr_code_base64": "data:image/png;base64,iVBORw0KGgoA...",
    "tags": [],
    "pixels": []
}

Query parameters

short_url string Required

The short link to get.

Example: https://t.ly/c55j

Update a short link

PUT https://api.t.ly/api/v1/link

Updates a short link. Omitted expire_at_datetime and expire_at_views are cleared, and omitted public_stats becomes false. Send their current values to preserve them. Omitted destination, ending, description, password, tags, pixels and metadata keep their current values.

500/minute · Shared general limit Needs an API token

Request

curl -X PUT https://api.t.ly/api/v1/link \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "short_url": "https://t.ly/c55j",
    "long_url": "https://weatherextension.com/",
    "description": "Social Media Link",
    "expire_at_datetime": "2035-01-17 15:00:00",
    "public_stats": true,
    "meta": {
        "expiration_url": "https://example.com/expired",
        "smart_urls": [
            {
                "conditions": [
                    "US",
                    "Android"
                ],
                "url": "https://example.com/us-android"
            }
        ]
    }
}'

const url = new URL(
    "https://api.t.ly/api/v1/link"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "short_url": "https:\/\/t.ly\/c55j",
    "long_url": "https:\/\/weatherextension.com\/",
    "description": "Social Media Link",
    "expire_at_datetime": "2035-01-17 15:00:00",
    "public_stats": true,
    "meta": {
        "expiration_url": "https:\/\/example.com\/expired",
        "smart_urls": [
            {
                "conditions": [
                    "US",
                    "Android"
                ],
                "url": "https:\/\/example.com\/us-android"
            }
        ]
    }
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/link';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'short_url' => 'https://t.ly/c55j',
            'long_url' => 'https://weatherextension.com/',
            'description' => 'Social Media Link',
            'expire_at_datetime' => '2035-01-17 15:00:00',
            'public_stats' => true,
            'meta' => [
                'expiration_url' => 'https://example.com/expired',
                'smart_urls' => [
                    [
                        'conditions' => [
                            'US',
                            'Android',
                        ],
                        'url' => 'https://example.com/us-android',
                    ],
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/link'
payload = {
    "short_url": "https:\/\/t.ly\/c55j",
    "long_url": "https:\/\/weatherextension.com\/",
    "description": "Social Media Link",
    "expire_at_datetime": "2035-01-17 15:00:00",
    "public_stats": true,
    "meta": {
        "expiration_url": "https:\/\/example.com\/expired",
        "smart_urls": [
            {
                "conditions": [
                    "US",
                    "Android"
                ],
                "url": "https:\/\/example.com\/us-android"
            }
        ]
    }
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Send a real request with your own token.

Try Update a short link

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

Body JSON

Response

{
    "short_url": "https://t.ly/c55j",
    "description": "Social Media Link",
    "long_url": "https://weatherextension.com/",
    "domain": "https://t.ly/",
    "short_id": "c55j",
    "expire_at_views": null,
    "expire_at_datetime": "2035-01-17 15:00:00",
    "public_stats": true,
    "created_at": "2026-11-07T12:00:00.000000Z",
    "updated_at": "2026-11-07T12:00:00.000000Z",
    "meta": {
        "expiration_url": "https://example.com/expired",
        "smart_urls": [
            {
                "conditions": [
                    "US",
                    "Android"
                ],
                "url": "https://example.com/us-android"
            }
        ],
        "rotation_urls": []
    }
}

Body parameters

short_url string Required

The short link to update.

Example: https://t.ly/c55j
long_url string

A new destination URL.

Example: https://weatherextension.com/
short_id string

A new ending after the domain, like fall-sale.
description string

A private note to help you find the link later, up to 200 characters.

Example: Social Media Link
expire_at_datetime string

When the link stops working, in UTC. Use YYYY-MM-DD HH:mm:ss.

Example: 2035-01-17 15:00:00
expire_at_views integer

Stop working after this many visits. Integer from 1 to 100000.
password string

Visitors must enter this password before they are sent on. Use 5 to 100 characters. Send an empty string to remove it.
public_stats boolean

Let anyone see the link's stats.

Example: true
tags array of integers

IDs of tags for the link. These replace its current tags.
pixels array of integers

IDs of retargeting pixels for the link. These replace its current pixels.
meta object

An expiration URL, Smart URLs or rotation URLs for A/B tests. Smart URLs and rotation URLs can't be used together; sending both returns a 422. See the Smart URL options.

Example: {"expiration_url":"https://example.com/expired","smart_urls":[{"conditions":["US","Android"],"url":"https://example.com/us-android"}]}

Delete a short link

DELETE https://api.t.ly/api/v1/link

Returns HTTP 202 with an empty body. Deletion may take time to complete. The link may continue redirecting until then.

500/minute · Shared general limit Needs an API token

Request

curl -X DELETE https://api.t.ly/api/v1/link \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "short_url": "https://t.ly/c55j"
}'

const url = new URL(
    "https://api.t.ly/api/v1/link"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "short_url": "https:\/\/t.ly\/c55j"
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/link';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'short_url' => 'https://t.ly/c55j',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/link'
payload = {
    "short_url": "https:\/\/t.ly\/c55j"
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers, json=payload)
response.json()

Send a real request with your own token.

Try Delete a short link

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

Body JSON

Response

No content

Body parameters

short_url string Required

The short link to delete.

Example: https://t.ly/c55j

Get link stats

GET https://api.t.ly/api/v1/link/stats

Returns visits, unique visits and QR scans for a short link. Summary counts use the selected date range; all_time ignores it. Unique counts add daily unique totals, so they do not count distinct people across the whole period. Grouped counts can be numeric strings. Results may be cached for a short period. When sections or country_code is supplied, cities are limited to the top 1000; city data requires ownership of the link.

500/minute · Shared general limit Needs an API token

Request

curl -X GET 'https://api.t.ly/api/v1/link/stats?short_url=https%3A%2F%2Ft.ly%2Fc55j&start_date=2025-08-01T00%3A00%3A00Z&end_date=2025-08-31T23%3A59%3A59Z&country_code=US&compare=previous' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/link/stats"
);

const params = {
    "short_url": "https://t.ly/c55j",
    "start_date": "2025-08-01T00:00:00Z",
    "end_date": "2025-08-31T23:59:59Z",
    "country_code": "US",
    "compare": "previous",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/link/stats';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
            'Content-Type' => 'application/json',
        ],
        'query' => [
            'short_url' => 'https://t.ly/c55j',
            'start_date' => '2025-08-01T00:00:00Z',
            'end_date' => '2025-08-31T23:59:59Z',
            'country_code' => 'US',
            'compare' => 'previous',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/link/stats'
params = {
  'short_url': 'https://t.ly/c55j',
  'start_date': '2025-08-01T00:00:00Z',
  'end_date': '2025-08-31T23:59:59Z',
  'country_code': 'US',
  'compare': 'previous',
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Send a real request with your own token.

Try Get link stats

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

short_url

start_date

end_date

sections

country_code

compare

Response

{
    "clicks": 0,
    "unique_clicks": 0,
    "total_qr_scans": 0,
    "all_time": {
        "clicks": 0,
        "unique_clicks": 0,
        "total_qr_scans": 0
    },
    "browsers": [],
    "countries": [],
    "referrers": [],
    "platforms": [],
    "languages": [],
    "cities": [],
    "daily_clicks": [],
    "data": {
        "long_url": "https://example.com/",
        "short_url": "https://t.ly/c55j",
        "created_at": "2022-01-16T19:10:36.000000Z",
        "last_clicked": null,
        "last_visit_at": null
    }
}

Query parameters

short_url string Required

The short link to get stats for.

Example: https://t.ly/c55j
start_date string

Start of the UTC reporting range. Defaults to the start of the day 7 days ago.

Example: 2025-08-01T00:00:00Z
end_date string

End of the UTC reporting range. Defaults to the end of today. Use an end-of-day timestamp to include a complete day.

Example: 2025-08-31T23:59:59Z
sections string

Comma-separated response sections: summary, breakdowns, browsers, countries, referrers, platforms, languages, cities, daily, comparison. Omit for summary, breakdowns, cities and daily. Use summary,comparison for just totals and a comparison.
country_code string

Filter the cities breakdown by country code.

Example: US
compare string

Comparison period: previous (default), year, or none. Include comparison in sections to return it.

One of previousyearnone

Get bulk job status

GET https://api.t.ly/api/v1/link/bulk/{job}

Checks a bulk create or update job for the token's team. Poll every 3–5 seconds while queued or processing. Stop at completed, completed_with_errors, or failed. Counts reflect finished rows; successful rows remain saved if other rows fail. Job history is kept for 30 days. Requests for unknown jobs or another team's jobs return 404.

500/minute · Shared general limit Needs an API token

Request

curl -X GET https://api.t.ly/api/v1/link/bulk/7f9874ce-7bd5-4e62-a1ed-3ffb35187358 \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/link/bulk/7f9874ce-7bd5-4e62-a1ed-3ffb35187358"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/link/bulk/7f9874ce-7bd5-4e62-a1ed-3ffb35187358';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/link/bulk/7f9874ce-7bd5-4e62-a1ed-3ffb35187358'
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Send a real request with your own token.

Try Get bulk job status

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

job in the URL

Response

{
    "job_id": "7f9874ce-7bd5-4e62-a1ed-3ffb35187358",
    "operation": "import",
    "status": "completed_with_errors",
    "total_count": 2,
    "processed_count": 2,
    "success_count": 1,
    "failed_count": 1,
    "skipped_count": 0,
    "progress": 100,
    "created_at": "2026-11-07T12:00:00.000000Z",
    "started_at": "2026-11-07T12:00:01.000000Z",
    "completed_at": "2026-11-07T12:00:10.000000Z",
    "status_url": "https://api.t.ly/api/v1/link/bulk/7f9874ce-7bd5-4e62-a1ed-3ffb35187358",
    "failures_url": "https://api.t.ly/api/v1/link/bulk/7f9874ce-7bd5-4e62-a1ed-3ffb35187358/failures",
    "download_failed_rows_url": "/links-import/export?import_id=42"
}

URL parameters

job string Required

The job ID returned by a bulk create or update request with return_job: true.

Example: 7f9874ce-7bd5-4e62-a1ed-3ffb35187358

List failed bulk rows

GET https://api.t.ly/api/v1/link/bulk/{job}/failures

Returns failed rows from a bulk create or update job, ordered by their original position. row_number starts at 1 for the first item in the submitted links array (the CSV header is not a row). Results may grow while the job runs, so retrieve them after a terminal status for a complete list. Fix and submit only failed rows to avoid repeating successful work. Passwords and internal errors are excluded. Jobs belong to the token's team and are kept for 30 days.

500/minute · Shared general limit Needs an API token

Request

curl -X GET 'https://api.t.ly/api/v1/link/bulk/7f9874ce-7bd5-4e62-a1ed-3ffb35187358/failures?page=1&limit=25' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/link/bulk/7f9874ce-7bd5-4e62-a1ed-3ffb35187358/failures"
);

const params = {
    "page": "1",
    "limit": "25",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/link/bulk/7f9874ce-7bd5-4e62-a1ed-3ffb35187358/failures';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
            'Content-Type' => 'application/json',
        ],
        'query' => [
            'page' => '1',
            'limit' => '25',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/link/bulk/7f9874ce-7bd5-4e62-a1ed-3ffb35187358/failures'
params = {
  'page': '1',
  'limit': '25',
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Send a real request with your own token.

Try List failed bulk rows

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

job in the URL

page

limit

Response

{
    "data": [
        {
            "row_number": 2,
            "long_url": "https://example.com/campaign",
            "short_url": null,
            "backhalf": "summer-sale",
            "error": "This link could not be imported. Check the destination URL and Backhalf."
        }
    ],
    "meta": {
        "current_page": 1,
        "last_page": 1,
        "per_page": 25,
        "total": 1
    }
}

URL parameters

job string Required

The job ID returned by a bulk create or update request with return_job: true.

Example: 7f9874ce-7bd5-4e62-a1ed-3ffb35187358

Query parameters

page integer

Page number, starting at 1.

Example: 1
limit integer

Rows per page. Default 25; maximum 100.

Example: 25

QR codes

Download a short link's QR code, or change its colors, style and logo.

Get a QR code

GET https://api.t.ly/api/v1/link/qr-code

Returns the QR code for a short link as a PNG image. Set output to base64 to get a base64 data URI in JSON instead.

500/minute · Shared general limit Needs an API token

Request

curl -X GET 'https://api.t.ly/api/v1/link/qr-code?short_url=https%3A%2F%2Ft.ly%2Fc55j&output=base64' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/link/qr-code"
);

const params = {
    "short_url": "https://t.ly/c55j",
    "output": "base64",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/link/qr-code';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
            'Content-Type' => 'application/json',
        ],
        'query' => [
            'short_url' => 'https://t.ly/c55j',
            'output' => 'base64',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/link/qr-code'
params = {
  'short_url': 'https://t.ly/c55j',
  'output': 'base64',
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Send a real request with your own token.

Try Get a QR code

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

short_url

output

Response

PNG image

{
    "base64": "data:image/png;base64,iVBORw0KGgoA..."
}

Query parameters

short_url string Required

The short link to get the QR code for.

Example: https://t.ly/c55j
output string

image (the default) or base64.

One of imagebase64

Update a QR code

PUT https://api.t.ly/api/v1/link/qr-code

Replaces a short link's QR styling: colors, dot and corner styles, and a logo in the middle. Omitted colors reset to the defaults below, omitted styles reset to square, and an omitted image removes the logo. Include every option you want to keep.

500/minute · Shared general limit Needs an API token

Request

curl -X PUT https://api.t.ly/api/v1/link/qr-code \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "short_url": "https://t.ly/c55j",
    "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8/x8AAwMCAO5L4GkAAAAASUVORK5CYII=",
    "background_color": "#ffffff",
    "corner_dots_color": "#000000",
    "dots_color": "#000000",
    "dots_style": "dot",
    "corner_style": "circle"
}'

const url = new URL(
    "https://api.t.ly/api/v1/link/qr-code"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "short_url": "https:\/\/t.ly\/c55j",
    "image": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8\/x8AAwMCAO5L4GkAAAAASUVORK5CYII=",
    "background_color": "#ffffff",
    "corner_dots_color": "#000000",
    "dots_color": "#000000",
    "dots_style": "dot",
    "corner_style": "circle"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/link/qr-code';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'short_url' => 'https://t.ly/c55j',
            'image' => 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8/x8AAwMCAO5L4GkAAAAASUVORK5CYII=',
            'background_color' => '#ffffff',
            'corner_dots_color' => '#000000',
            'dots_color' => '#000000',
            'dots_style' => 'dot',
            'corner_style' => 'circle',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/link/qr-code'
payload = {
    "short_url": "https:\/\/t.ly\/c55j",
    "image": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8\/x8AAwMCAO5L4GkAAAAASUVORK5CYII=",
    "background_color": "#ffffff",
    "corner_dots_color": "#000000",
    "dots_color": "#000000",
    "dots_style": "dot",
    "corner_style": "circle"
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Send a real request with your own token.

Try Update a QR code

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

Body JSON

Response

{
    "id": 123,
    "short_url": "https://t.ly/c55j",
    "qr_code_options": {
        "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8/x8AAwMCAO5L4GkAAAAASUVORK5CYII=",
        "background_color": "#ffffff",
        "corner_dots_color": "#000000",
        "dots_color": "#000000",
        "dots_style": "dot",
        "corner_style": "circle"
    },
    "team_id": 5,
    "user_id": 42,
    "updated_at": "2025-08-25T20:55:00Z"
}

Body parameters

short_url string Required

The short link the QR code belongs to.

Example: https://t.ly/c55j
image string

A logo to put in the middle, as a base64 data URI. PNG or JPG, up to about 500 KB. Send null to remove it.

Example: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8/x8AAwMCAO5L4GkAAAAASUVORK5CYII=
background_color string

Background color in hex. Defaults to #ffffff.

Example: #ffffff
corner_dots_color string

Corner color in hex. Defaults to #000000.

Example: #000000
dots_color string

Dot color in hex. Defaults to #000000.

Example: #000000
dots_style string

Defaults to square.

One of squaredot
corner_style string

Defaults to square.

One of squarecircle

OneLinks

List your OneLink pages and get their visits and button clicks.

List OneLinks

GET https://api.t.ly/api/v1/onelink/list

Returns your team's OneLinks, 30 per page, most recently updated first. Use page to continue while current_page is less than last_page.

500/minute · Shared general limit Needs an API token

Request

curl -X GET 'https://api.t.ly/api/v1/onelink/list?page=1' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/onelink/list"
);

const params = {
    "page": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/onelink/list';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
        ],
        'query' => [
            'page' => '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/onelink/list'
params = {
  'page': '1',
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Send a real request with your own token.

Try List OneLinks

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

page

Response

{
    "current_page": 1,
    "data": [
        {
            "id": 123,
            "short_id": "one",
            "short_url": "https://t.ly/one",
            "domain": "https://t.ly/",
            "title": "My OneLink",
            "description": "All my links",
            "avatar_url": "https://t.ly/storage/onelinks/123/avatar.png",
            "meta": {
                "appearance": {
                    "background_color": "#3b3c3d",
                    "button_color": "#ffffff",
                    "button_font_color": "#3b3c3d",
                    "heading_font_color": "#ffffff",
                    "social_media_icon_color": "#ffffff"
                },
                "qr_code_options": {}
            },
            "template_key": "classic",
            "theme_overrides_json": {},
            "blocks_json": [],
            "has_password": false,
            "created_at": "2026-11-01T12:00:00.000000Z",
            "updated_at": "2024-06-02T12:00:00.000000Z",
            "user": {
                "id": 9,
                "name": "Jane Doe",
                "email": "[email protected]"
            },
            "links": [
                {
                    "id": 55,
                    "title": "Website",
                    "url": "https://example.com",
                    "type": "link",
                    "sort_order": 1
                }
            ],
            "social_links": [
                {
                    "id": 56,
                    "title": null,
                    "url": "https://twitter.com/example",
                    "type": "social",
                    "sub_type": "twitter",
                    "sort_order": 1
                }
            ],
            "stat_total": {
                "one_link_id": 123,
                "total": 42,
                "unique_total": 39,
                "qr_total": 3
            },
            "tags": []
        }
    ],
    "per_page": 30,
    "total": 1
}

Query parameters

page integer

Page number, starting at 1.

Example: 1

Get OneLink stats

GET https://api.t.ly/api/v1/onelink/stats

Returns OneLink page visits in clicks, unique_clicks and total_qr_scans, and button interactions in link_clicks. Summary counts use the selected date range; all_time ignores it. Unique counts add daily unique totals, so they do not count distinct people across the whole period. Grouped counts can be numeric strings. Results may be cached for a short period. When sections or country_code is supplied, cities are limited to the top 1000.

500/minute · Shared general limit Needs an API token

Request

curl -X GET 'https://api.t.ly/api/v1/onelink/stats?short_url=https%3A%2F%2Ft.ly%2Fone&start_date=2026-11-01&end_date=2026-11-07&country_code=US&compare=previous' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/onelink/stats"
);

const params = {
    "short_url": "https://t.ly/one",
    "start_date": "2026-11-01",
    "end_date": "2026-11-07",
    "country_code": "US",
    "compare": "previous",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/onelink/stats';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
            'Content-Type' => 'application/json',
        ],
        'query' => [
            'short_url' => 'https://t.ly/one',
            'start_date' => '2026-11-01',
            'end_date' => '2026-11-07',
            'country_code' => 'US',
            'compare' => 'previous',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/onelink/stats'
params = {
  'short_url': 'https://t.ly/one',
  'start_date': '2026-11-01',
  'end_date': '2026-11-07',
  'country_code': 'US',
  'compare': 'previous',
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Send a real request with your own token.

Try Get OneLink stats

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

short_url

start_date

end_date

sections

country_code

compare

Response

{
    "clicks": 120,
    "unique_clicks": 98,
    "total_qr_scans": 6,
    "all_time": {
        "clicks": 200,
        "unique_clicks": 150,
        "total_qr_scans": 10
    },
    "browsers": [
        {
            "browser": "Chrome",
            "total": 80,
            "unique_total": 65,
            "qr_total": 3
        }
    ],
    "countries": [
        {
            "country_code": "US",
            "total": 90,
            "unique_total": 75,
            "qr_total": 4
        }
    ],
    "cities": [
        {
            "country_code": "US",
            "region": "CA",
            "city": "San Francisco",
            "total": 30,
            "unique_total": 24,
            "qr_total": 1
        }
    ],
    "referrers": [
        {
            "referrer": "direct",
            "total": 40,
            "unique_total": 35,
            "qr_total": 2
        }
    ],
    "platforms": [
        {
            "platform": "Mac OS",
            "total": 50,
            "unique_total": 40,
            "qr_total": 2
        }
    ],
    "daily_clicks": [
        {
            "label": "2026-11-01",
            "total": 20,
            "unique_total": 18,
            "qr_total": 1
        }
    ],
    "link_clicks": [
        {
            "link_id": 55,
            "title": "Website",
            "url": "https://example.com",
            "total": 70,
            "unique_total": 60
        }
    ],
    "data": {
        "short_url": "https://t.ly/one",
        "title": "My OneLink",
        "description": "All my links",
        "created_at": "2026-11-01T12:00:00.000000Z",
        "last_clicked": "2026-11-07T12:00:00.000000Z"
    }
}

Query parameters

short_url string Required

The OneLink to get stats for.

Example: https://t.ly/one
start_date string

Start of the UTC reporting range. Defaults to the start of the day 7 days ago.

Example: 2026-11-01
end_date string

End of the UTC reporting range. Defaults to the end of today. Use an end-of-day timestamp to include a complete day.

Example: 2026-11-07
sections string

Comma-separated response sections: summary, breakdowns, browsers, countries, referrers, platforms, languages, link_clicks, cities, daily, comparison. Omit for summary, breakdowns, cities and daily. Use summary,comparison for just totals and a comparison.
country_code string

Filter the cities breakdown by country code.

Example: US
compare string

Comparison period: previous (default), year, or none. Include comparison in sections to return it.

One of previousyearnone

Team analytics

Report on visits, top links and traffic sources across your team, or page through individual visits and QR scans.

Get team visits

GET https://api.t.ly/api/v1/team/stats/visits

Returns visit totals across matching links. Reports use the token's team and aggregate daily analytics. total includes QR visits; qr_total is the QR subset. unique_total adds daily unique counts and is not a count of distinct people across the whole period. Counts in grouped rows can be numeric strings. Results may be cached for a short period. Filters apply together; values within an array match any listed value. Use UTC calendar dates for consistent day boundaries.

500/minute · Shared general limit Needs an API token

Request

curl -X GET 'https://api.t.ly/api/v1/team/stats/visits?start_date=2026-11-01&end_date=2026-11-07T23%3A59%3A59Z&domains%5B0%5D=https%3A%2F%2Ft.ly%2F&link_type%5B0%5D=links&link_type%5B1%5D=one_links' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/team/stats/visits"
);

const params = {
    "start_date": "2026-11-01",
    "end_date": "2026-11-07T23:59:59Z",
    "tag_ids": "",
    "pixel_ids": "",
    "domains[0]": "https://t.ly/",
    "user_ids": "",
    "link_type[0]": "links",
    "link_type[1]": "one_links",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/team/stats/visits';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
        ],
        'query' => [
            'start_date' => '2026-11-01',
            'end_date' => '2026-11-07T23:59:59Z',
            'tag_ids' => '',
            'pixel_ids' => '',
            'domains[0]' => 'https://t.ly/',
            'user_ids' => '',
            'link_type[0]' => 'links',
            'link_type[1]' => 'one_links',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/team/stats/visits'
params = {
  'start_date': '2026-11-01',
  'end_date': '2026-11-07T23:59:59Z',
  'tag_ids': '',
  'pixel_ids': '',
  'domains[0]': 'https://t.ly/',
  'user_ids': '',
  'link_type[0]': 'links',
  'link_type[1]': 'one_links',
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Send a real request with your own token.

Try Get team visits

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

start_date

end_date

tag_ids comma-separated

pixel_ids comma-separated

domains comma-separated

user_ids comma-separated

link_type comma-separated

Response

{
    "total": 120,
    "unique_total": 95,
    "qr_total": 20
}

Query parameters

start_date string

Start of the reporting range. Use a UTC calendar date. Defaults to the start of the day 30 days ago.

Example: 2026-11-01
end_date string

End of the reporting range. Use a UTC end-of-day timestamp to include a complete day. Defaults to the end of today.

Example: 2026-11-07T23:59:59Z
tag_ids array of integers

Match links with any of these tag IDs. Up to 10.
pixel_ids array of integers

Match short links with any of these pixel IDs. Up to 10. This filter does not apply to OneLinks.
domains array of strings

Domain URL strings, including scheme and trailing slash. Up to 10.

Example: ["https://t.ly/"]
user_ids array of integers

IDs of the team members who created the links. Up to 10. Find them with List team members.
link_type array of strings

Include links, one_links, or both. Defaults to ["links"].

Example: ["links","one_links"]

Get daily team visits

GET https://api.t.ly/api/v1/team/stats/daily-visits

Returns matching visits by day, oldest day first. Days without recorded visits are omitted. Reports use the token's team and aggregate daily analytics. total includes QR visits; qr_total is the QR subset. unique_total adds daily unique counts and is not a count of distinct people across the whole period. Counts in grouped rows can be numeric strings. Results may be cached for a short period. Filters apply together; values within an array match any listed value. Use UTC calendar dates for consistent day boundaries.

500/minute · Shared general limit Needs an API token

Request

curl -X GET 'https://api.t.ly/api/v1/team/stats/daily-visits?start_date=2026-11-01&end_date=2026-11-07T23%3A59%3A59Z&domains%5B0%5D=https%3A%2F%2Ft.ly%2F&link_type%5B0%5D=links&link_type%5B1%5D=one_links' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/team/stats/daily-visits"
);

const params = {
    "start_date": "2026-11-01",
    "end_date": "2026-11-07T23:59:59Z",
    "tag_ids": "",
    "pixel_ids": "",
    "domains[0]": "https://t.ly/",
    "user_ids": "",
    "link_type[0]": "links",
    "link_type[1]": "one_links",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/team/stats/daily-visits';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
        ],
        'query' => [
            'start_date' => '2026-11-01',
            'end_date' => '2026-11-07T23:59:59Z',
            'tag_ids' => '',
            'pixel_ids' => '',
            'domains[0]' => 'https://t.ly/',
            'user_ids' => '',
            'link_type[0]' => 'links',
            'link_type[1]' => 'one_links',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/team/stats/daily-visits'
params = {
  'start_date': '2026-11-01',
  'end_date': '2026-11-07T23:59:59Z',
  'tag_ids': '',
  'pixel_ids': '',
  'domains[0]': 'https://t.ly/',
  'user_ids': '',
  'link_type[0]': 'links',
  'link_type[1]': 'one_links',
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Send a real request with your own token.

Try Get daily team visits

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

start_date

end_date

tag_ids comma-separated

pixel_ids comma-separated

domains comma-separated

user_ids comma-separated

link_type comma-separated

Response

[
    {
        "label": "2026-11-01",
        "total": "120",
        "unique_total": "95",
        "qr_total": "20"
    }
]

Query parameters

start_date string

Start of the reporting range. Use a UTC calendar date. Defaults to the start of the day 30 days ago.

Example: 2026-11-01
end_date string

End of the reporting range. Use a UTC end-of-day timestamp to include a complete day. Defaults to the end of today.

Example: 2026-11-07T23:59:59Z
tag_ids array of integers

Match links with any of these tag IDs. Up to 10.
pixel_ids array of integers

Match short links with any of these pixel IDs. Up to 10. This filter does not apply to OneLinks.
domains array of strings

Domain URL strings, including scheme and trailing slash. Up to 10.

Example: ["https://t.ly/"]
user_ids array of integers

IDs of the team members who created the links. Up to 10. Find them with List team members.
link_type array of strings

Include links, one_links, or both. Defaults to ["links"].

Example: ["links","one_links"]

List top team links

GET https://api.t.ly/api/v1/team/stats/top-short-links

Returns matching links ranked by visit count, highest first, with 10 links per page. Only links with recorded analytics in the range appear. Use page to continue while current_page < last_page. The path also supports OneLinks through link_type. Reports use the token's team and aggregate daily analytics. total includes QR visits; qr_total is the QR subset. unique_total adds daily unique counts and is not a count of distinct people across the whole period. Counts in grouped rows can be numeric strings. Results may be cached for a short period. Filters apply together; values within an array match any listed value. Use UTC calendar dates for consistent day boundaries.

500/minute · Shared general limit Needs an API token

Request

curl -X GET 'https://api.t.ly/api/v1/team/stats/top-short-links?start_date=2026-11-01&end_date=2026-11-07T23%3A59%3A59Z&domains%5B0%5D=https%3A%2F%2Ft.ly%2F&link_type%5B0%5D=links&link_type%5B1%5D=one_links&page=1' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/team/stats/top-short-links"
);

const params = {
    "start_date": "2026-11-01",
    "end_date": "2026-11-07T23:59:59Z",
    "tag_ids": "",
    "pixel_ids": "",
    "domains[0]": "https://t.ly/",
    "user_ids": "",
    "link_type[0]": "links",
    "link_type[1]": "one_links",
    "page": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/team/stats/top-short-links';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
        ],
        'query' => [
            'start_date' => '2026-11-01',
            'end_date' => '2026-11-07T23:59:59Z',
            'tag_ids' => '',
            'pixel_ids' => '',
            'domains[0]' => 'https://t.ly/',
            'user_ids' => '',
            'link_type[0]' => 'links',
            'link_type[1]' => 'one_links',
            'page' => '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/team/stats/top-short-links'
params = {
  'start_date': '2026-11-01',
  'end_date': '2026-11-07T23:59:59Z',
  'tag_ids': '',
  'pixel_ids': '',
  'domains[0]': 'https://t.ly/',
  'user_ids': '',
  'link_type[0]': 'links',
  'link_type[1]': 'one_links',
  'page': '1',
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Send a real request with your own token.

Try List top team links

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

start_date

end_date

tag_ids comma-separated

pixel_ids comma-separated

domains comma-separated

user_ids comma-separated

link_type comma-separated

page

Response

{
    "current_page": 1,
    "data": [
        {
            "short_url": "https://t.ly/fall-sale",
            "total": "120",
            "unique_total": "95",
            "qr_total": "20",
            "link_type": "links"
        }
    ],
    "per_page": 10,
    "total": 1,
    "last_page": 1,
    "next_page_url": null
}

Query parameters

start_date string

Start of the reporting range. Use a UTC calendar date. Defaults to the start of the day 30 days ago.

Example: 2026-11-01
end_date string

End of the reporting range. Use a UTC end-of-day timestamp to include a complete day. Defaults to the end of today.

Example: 2026-11-07T23:59:59Z
tag_ids array of integers

Match links with any of these tag IDs. Up to 10.
pixel_ids array of integers

Match short links with any of these pixel IDs. Up to 10. This filter does not apply to OneLinks.
domains array of strings

Domain URL strings, including scheme and trailing slash. Up to 10.

Example: ["https://t.ly/"]
user_ids array of integers

IDs of the team members who created the links. Up to 10. Find them with List team members.
link_type array of strings

Include links, one_links, or both. Defaults to ["links"].

Example: ["links","one_links"]
page integer

Page number, starting at 1.

Example: 1

Get team countries

GET https://api.t.ly/api/v1/team/stats/countries

Returns visits grouped by countries. Row order is unspecified; sort in your client if needed. Reports use the token's team and aggregate daily analytics. total includes QR visits; qr_total is the QR subset. unique_total adds daily unique counts and is not a count of distinct people across the whole period. Counts in grouped rows can be numeric strings. Results may be cached for a short period. Filters apply together; values within an array match any listed value. Use UTC calendar dates for consistent day boundaries.

500/minute · Shared general limit Needs an API token

Request

curl -X GET 'https://api.t.ly/api/v1/team/stats/countries?start_date=2026-11-01&end_date=2026-11-07T23%3A59%3A59Z&domains%5B0%5D=https%3A%2F%2Ft.ly%2F&link_type%5B0%5D=links&link_type%5B1%5D=one_links' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/team/stats/countries"
);

const params = {
    "start_date": "2026-11-01",
    "end_date": "2026-11-07T23:59:59Z",
    "tag_ids": "",
    "pixel_ids": "",
    "domains[0]": "https://t.ly/",
    "user_ids": "",
    "link_type[0]": "links",
    "link_type[1]": "one_links",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/team/stats/countries';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
        ],
        'query' => [
            'start_date' => '2026-11-01',
            'end_date' => '2026-11-07T23:59:59Z',
            'tag_ids' => '',
            'pixel_ids' => '',
            'domains[0]' => 'https://t.ly/',
            'user_ids' => '',
            'link_type[0]' => 'links',
            'link_type[1]' => 'one_links',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/team/stats/countries'
params = {
  'start_date': '2026-11-01',
  'end_date': '2026-11-07T23:59:59Z',
  'tag_ids': '',
  'pixel_ids': '',
  'domains[0]': 'https://t.ly/',
  'user_ids': '',
  'link_type[0]': 'links',
  'link_type[1]': 'one_links',
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Send a real request with your own token.

Try Get team countries

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

start_date

end_date

tag_ids comma-separated

pixel_ids comma-separated

domains comma-separated

user_ids comma-separated

link_type comma-separated

Response

[
    {
        "country_code": "US",
        "total": "120",
        "unique_total": "95",
        "qr_total": "20"
    }
]

Query parameters

start_date string

Start of the reporting range. Use a UTC calendar date. Defaults to the start of the day 30 days ago.

Example: 2026-11-01
end_date string

End of the reporting range. Use a UTC end-of-day timestamp to include a complete day. Defaults to the end of today.

Example: 2026-11-07T23:59:59Z
tag_ids array of integers

Match links with any of these tag IDs. Up to 10.
pixel_ids array of integers

Match short links with any of these pixel IDs. Up to 10. This filter does not apply to OneLinks.
domains array of strings

Domain URL strings, including scheme and trailing slash. Up to 10.

Example: ["https://t.ly/"]
user_ids array of integers

IDs of the team members who created the links. Up to 10. Find them with List team members.
link_type array of strings

Include links, one_links, or both. Defaults to ["links"].

Example: ["links","one_links"]

Get team cities

GET https://api.t.ly/api/v1/team/stats/cities

Returns visits grouped by cities. Row order is unspecified; sort in your client if needed. Reports use the token's team and aggregate daily analytics. total includes QR visits; qr_total is the QR subset. unique_total adds daily unique counts and is not a count of distinct people across the whole period. Counts in grouped rows can be numeric strings. Results may be cached for a short period. Filters apply together; values within an array match any listed value. Use UTC calendar dates for consistent day boundaries.

500/minute · Shared general limit Needs an API token

Request

curl -X GET 'https://api.t.ly/api/v1/team/stats/cities?start_date=2026-11-01&end_date=2026-11-07T23%3A59%3A59Z&domains%5B0%5D=https%3A%2F%2Ft.ly%2F&link_type%5B0%5D=links&link_type%5B1%5D=one_links' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/team/stats/cities"
);

const params = {
    "start_date": "2026-11-01",
    "end_date": "2026-11-07T23:59:59Z",
    "tag_ids": "",
    "pixel_ids": "",
    "domains[0]": "https://t.ly/",
    "user_ids": "",
    "link_type[0]": "links",
    "link_type[1]": "one_links",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/team/stats/cities';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
        ],
        'query' => [
            'start_date' => '2026-11-01',
            'end_date' => '2026-11-07T23:59:59Z',
            'tag_ids' => '',
            'pixel_ids' => '',
            'domains[0]' => 'https://t.ly/',
            'user_ids' => '',
            'link_type[0]' => 'links',
            'link_type[1]' => 'one_links',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/team/stats/cities'
params = {
  'start_date': '2026-11-01',
  'end_date': '2026-11-07T23:59:59Z',
  'tag_ids': '',
  'pixel_ids': '',
  'domains[0]': 'https://t.ly/',
  'user_ids': '',
  'link_type[0]': 'links',
  'link_type[1]': 'one_links',
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Send a real request with your own token.

Try Get team cities

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

start_date

end_date

tag_ids comma-separated

pixel_ids comma-separated

domains comma-separated

user_ids comma-separated

link_type comma-separated

Response

[
    {
        "country_code": "US",
        "region": "NY",
        "city": "New York City",
        "total": "120",
        "unique_total": "95",
        "qr_total": "20"
    }
]

Query parameters

start_date string

Start of the reporting range. Use a UTC calendar date. Defaults to the start of the day 30 days ago.

Example: 2026-11-01
end_date string

End of the reporting range. Use a UTC end-of-day timestamp to include a complete day. Defaults to the end of today.

Example: 2026-11-07T23:59:59Z
tag_ids array of integers

Match links with any of these tag IDs. Up to 10.
pixel_ids array of integers

Match short links with any of these pixel IDs. Up to 10. This filter does not apply to OneLinks.
domains array of strings

Domain URL strings, including scheme and trailing slash. Up to 10.

Example: ["https://t.ly/"]
user_ids array of integers

IDs of the team members who created the links. Up to 10. Find them with List team members.
link_type array of strings

Include links, one_links, or both. Defaults to ["links"].

Example: ["links","one_links"]

Get team referrers

GET https://api.t.ly/api/v1/team/stats/referrers

Returns visits grouped by referrers. Row order is unspecified; sort in your client if needed. Reports use the token's team and aggregate daily analytics. total includes QR visits; qr_total is the QR subset. unique_total adds daily unique counts and is not a count of distinct people across the whole period. Counts in grouped rows can be numeric strings. Results may be cached for a short period. Filters apply together; values within an array match any listed value. Use UTC calendar dates for consistent day boundaries.

500/minute · Shared general limit Needs an API token

Request

curl -X GET 'https://api.t.ly/api/v1/team/stats/referrers?start_date=2026-11-01&end_date=2026-11-07T23%3A59%3A59Z&domains%5B0%5D=https%3A%2F%2Ft.ly%2F&link_type%5B0%5D=links&link_type%5B1%5D=one_links' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/team/stats/referrers"
);

const params = {
    "start_date": "2026-11-01",
    "end_date": "2026-11-07T23:59:59Z",
    "tag_ids": "",
    "pixel_ids": "",
    "domains[0]": "https://t.ly/",
    "user_ids": "",
    "link_type[0]": "links",
    "link_type[1]": "one_links",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/team/stats/referrers';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
        ],
        'query' => [
            'start_date' => '2026-11-01',
            'end_date' => '2026-11-07T23:59:59Z',
            'tag_ids' => '',
            'pixel_ids' => '',
            'domains[0]' => 'https://t.ly/',
            'user_ids' => '',
            'link_type[0]' => 'links',
            'link_type[1]' => 'one_links',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/team/stats/referrers'
params = {
  'start_date': '2026-11-01',
  'end_date': '2026-11-07T23:59:59Z',
  'tag_ids': '',
  'pixel_ids': '',
  'domains[0]': 'https://t.ly/',
  'user_ids': '',
  'link_type[0]': 'links',
  'link_type[1]': 'one_links',
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Send a real request with your own token.

Try Get team referrers

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

start_date

end_date

tag_ids comma-separated

pixel_ids comma-separated

domains comma-separated

user_ids comma-separated

link_type comma-separated

Response

[
    {
        "referrer": "google.com",
        "total": "120",
        "unique_total": "95",
        "qr_total": "20"
    }
]

Query parameters

start_date string

Start of the reporting range. Use a UTC calendar date. Defaults to the start of the day 30 days ago.

Example: 2026-11-01
end_date string

End of the reporting range. Use a UTC end-of-day timestamp to include a complete day. Defaults to the end of today.

Example: 2026-11-07T23:59:59Z
tag_ids array of integers

Match links with any of these tag IDs. Up to 10.
pixel_ids array of integers

Match short links with any of these pixel IDs. Up to 10. This filter does not apply to OneLinks.
domains array of strings

Domain URL strings, including scheme and trailing slash. Up to 10.

Example: ["https://t.ly/"]
user_ids array of integers

IDs of the team members who created the links. Up to 10. Find them with List team members.
link_type array of strings

Include links, one_links, or both. Defaults to ["links"].

Example: ["links","one_links"]

Get team platforms

GET https://api.t.ly/api/v1/team/stats/platforms

Returns visits grouped by platforms. Row order is unspecified; sort in your client if needed. Reports use the token's team and aggregate daily analytics. total includes QR visits; qr_total is the QR subset. unique_total adds daily unique counts and is not a count of distinct people across the whole period. Counts in grouped rows can be numeric strings. Results may be cached for a short period. Filters apply together; values within an array match any listed value. Use UTC calendar dates for consistent day boundaries.

500/minute · Shared general limit Needs an API token

Request

curl -X GET 'https://api.t.ly/api/v1/team/stats/platforms?start_date=2026-11-01&end_date=2026-11-07T23%3A59%3A59Z&domains%5B0%5D=https%3A%2F%2Ft.ly%2F&link_type%5B0%5D=links&link_type%5B1%5D=one_links' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/team/stats/platforms"
);

const params = {
    "start_date": "2026-11-01",
    "end_date": "2026-11-07T23:59:59Z",
    "tag_ids": "",
    "pixel_ids": "",
    "domains[0]": "https://t.ly/",
    "user_ids": "",
    "link_type[0]": "links",
    "link_type[1]": "one_links",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/team/stats/platforms';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
        ],
        'query' => [
            'start_date' => '2026-11-01',
            'end_date' => '2026-11-07T23:59:59Z',
            'tag_ids' => '',
            'pixel_ids' => '',
            'domains[0]' => 'https://t.ly/',
            'user_ids' => '',
            'link_type[0]' => 'links',
            'link_type[1]' => 'one_links',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/team/stats/platforms'
params = {
  'start_date': '2026-11-01',
  'end_date': '2026-11-07T23:59:59Z',
  'tag_ids': '',
  'pixel_ids': '',
  'domains[0]': 'https://t.ly/',
  'user_ids': '',
  'link_type[0]': 'links',
  'link_type[1]': 'one_links',
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Send a real request with your own token.

Try Get team platforms

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

start_date

end_date

tag_ids comma-separated

pixel_ids comma-separated

domains comma-separated

user_ids comma-separated

link_type comma-separated

Response

[
    {
        "platform": "Mac OS",
        "total": "120",
        "unique_total": "95",
        "qr_total": "20"
    }
]

Query parameters

start_date string

Start of the reporting range. Use a UTC calendar date. Defaults to the start of the day 30 days ago.

Example: 2026-11-01
end_date string

End of the reporting range. Use a UTC end-of-day timestamp to include a complete day. Defaults to the end of today.

Example: 2026-11-07T23:59:59Z
tag_ids array of integers

Match links with any of these tag IDs. Up to 10.
pixel_ids array of integers

Match short links with any of these pixel IDs. Up to 10. This filter does not apply to OneLinks.
domains array of strings

Domain URL strings, including scheme and trailing slash. Up to 10.

Example: ["https://t.ly/"]
user_ids array of integers

IDs of the team members who created the links. Up to 10. Find them with List team members.
link_type array of strings

Include links, one_links, or both. Defaults to ["links"].

Example: ["links","one_links"]

Get team browsers

GET https://api.t.ly/api/v1/team/stats/browsers

Returns visits grouped by browsers. Row order is unspecified; sort in your client if needed. Reports use the token's team and aggregate daily analytics. total includes QR visits; qr_total is the QR subset. unique_total adds daily unique counts and is not a count of distinct people across the whole period. Counts in grouped rows can be numeric strings. Results may be cached for a short period. Filters apply together; values within an array match any listed value. Use UTC calendar dates for consistent day boundaries.

500/minute · Shared general limit Needs an API token

Request

curl -X GET 'https://api.t.ly/api/v1/team/stats/browsers?start_date=2026-11-01&end_date=2026-11-07T23%3A59%3A59Z&domains%5B0%5D=https%3A%2F%2Ft.ly%2F&link_type%5B0%5D=links&link_type%5B1%5D=one_links' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/team/stats/browsers"
);

const params = {
    "start_date": "2026-11-01",
    "end_date": "2026-11-07T23:59:59Z",
    "tag_ids": "",
    "pixel_ids": "",
    "domains[0]": "https://t.ly/",
    "user_ids": "",
    "link_type[0]": "links",
    "link_type[1]": "one_links",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/team/stats/browsers';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
        ],
        'query' => [
            'start_date' => '2026-11-01',
            'end_date' => '2026-11-07T23:59:59Z',
            'tag_ids' => '',
            'pixel_ids' => '',
            'domains[0]' => 'https://t.ly/',
            'user_ids' => '',
            'link_type[0]' => 'links',
            'link_type[1]' => 'one_links',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/team/stats/browsers'
params = {
  'start_date': '2026-11-01',
  'end_date': '2026-11-07T23:59:59Z',
  'tag_ids': '',
  'pixel_ids': '',
  'domains[0]': 'https://t.ly/',
  'user_ids': '',
  'link_type[0]': 'links',
  'link_type[1]': 'one_links',
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Send a real request with your own token.

Try Get team browsers

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

start_date

end_date

tag_ids comma-separated

pixel_ids comma-separated

domains comma-separated

user_ids comma-separated

link_type comma-separated

Response

[
    {
        "browser": "Chrome",
        "total": "120",
        "unique_total": "95",
        "qr_total": "20"
    }
]

Query parameters

start_date string

Start of the reporting range. Use a UTC calendar date. Defaults to the start of the day 30 days ago.

Example: 2026-11-01
end_date string

End of the reporting range. Use a UTC end-of-day timestamp to include a complete day. Defaults to the end of today.

Example: 2026-11-07T23:59:59Z
tag_ids array of integers

Match links with any of these tag IDs. Up to 10.
pixel_ids array of integers

Match short links with any of these pixel IDs. Up to 10. This filter does not apply to OneLinks.
domains array of strings

Domain URL strings, including scheme and trailing slash. Up to 10.

Example: ["https://t.ly/"]
user_ids array of integers

IDs of the team members who created the links. Up to 10. Find them with List team members.
link_type array of strings

Include links, one_links, or both. Defaults to ["links"].

Example: ["links","one_links"]

Get team languages

GET https://api.t.ly/api/v1/team/stats/languages

Returns visits grouped by languages. Row order is unspecified; sort in your client if needed. Reports use the token's team and aggregate daily analytics. total includes QR visits; qr_total is the QR subset. unique_total adds daily unique counts and is not a count of distinct people across the whole period. Counts in grouped rows can be numeric strings. Results may be cached for a short period. Filters apply together; values within an array match any listed value. Use UTC calendar dates for consistent day boundaries.

500/minute · Shared general limit Needs an API token

Request

curl -X GET 'https://api.t.ly/api/v1/team/stats/languages?start_date=2026-11-01&end_date=2026-11-07T23%3A59%3A59Z&domains%5B0%5D=https%3A%2F%2Ft.ly%2F&link_type%5B0%5D=links&link_type%5B1%5D=one_links' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/team/stats/languages"
);

const params = {
    "start_date": "2026-11-01",
    "end_date": "2026-11-07T23:59:59Z",
    "tag_ids": "",
    "pixel_ids": "",
    "domains[0]": "https://t.ly/",
    "user_ids": "",
    "link_type[0]": "links",
    "link_type[1]": "one_links",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/team/stats/languages';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
        ],
        'query' => [
            'start_date' => '2026-11-01',
            'end_date' => '2026-11-07T23:59:59Z',
            'tag_ids' => '',
            'pixel_ids' => '',
            'domains[0]' => 'https://t.ly/',
            'user_ids' => '',
            'link_type[0]' => 'links',
            'link_type[1]' => 'one_links',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/team/stats/languages'
params = {
  'start_date': '2026-11-01',
  'end_date': '2026-11-07T23:59:59Z',
  'tag_ids': '',
  'pixel_ids': '',
  'domains[0]': 'https://t.ly/',
  'user_ids': '',
  'link_type[0]': 'links',
  'link_type[1]': 'one_links',
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Send a real request with your own token.

Try Get team languages

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

start_date

end_date

tag_ids comma-separated

pixel_ids comma-separated

domains comma-separated

user_ids comma-separated

link_type comma-separated

Response

[
    {
        "language": "en",
        "total": "120",
        "unique_total": "95",
        "qr_total": "20"
    }
]

Query parameters

start_date string

Start of the reporting range. Use a UTC calendar date. Defaults to the start of the day 30 days ago.

Example: 2026-11-01
end_date string

End of the reporting range. Use a UTC end-of-day timestamp to include a complete day. Defaults to the end of today.

Example: 2026-11-07T23:59:59Z
tag_ids array of integers

Match links with any of these tag IDs. Up to 10.
pixel_ids array of integers

Match short links with any of these pixel IDs. Up to 10. This filter does not apply to OneLinks.
domains array of strings

Domain URL strings, including scheme and trailing slash. Up to 10.

Example: ["https://t.ly/"]
user_ids array of integers

IDs of the team members who created the links. Up to 10. Find them with List team members.
link_type array of strings

Include links, one_links, or both. Defaults to ["links"].

Example: ["links","one_links"]

List team visits

GET https://api.t.ly/api/v1/team/clicks

Returns individual visits and QR scans, newest first, for links still in the token's team. Use key as the row identifier. OneLink rows have a null destination; visitor details can be null or unknown. IP addresses are excluded. History is limited by your plan, and earliest_available gives its cutoff. An empty data array is a valid result. To read older visits, send next_cursor as cursor with the same filters and fixed dates; stop when next_cursor is null. This is a paginated history API, not a live event stream. An invalid cursor returns 422. A query timeout returns 503 with timed_out: true; retry with a shorter date range.

500/minute · Shared general limit Needs an API token

Request

curl -X GET 'https://api.t.ly/api/v1/team/clicks?start_date=2026-11-01T00%3A00%3A00Z&end_date=2026-11-07T12%3A00%3A00Z&limit=50&link_type%5B0%5D=links&link_type%5B1%5D=one_links' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/team/clicks"
);

const params = {
    "start_date": "2026-11-01T00:00:00Z",
    "end_date": "2026-11-07T12:00:00Z",
    "cursor": "",
    "limit": "50",
    "link_type[0]": "links",
    "link_type[1]": "one_links",
    "short_urls": "",
    "countries": "",
    "referrers": "",
    "visit_type": "",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/team/clicks';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
        ],
        'query' => [
            'start_date' => '2026-11-01T00:00:00Z',
            'end_date' => '2026-11-07T12:00:00Z',
            'cursor' => '',
            'limit' => '50',
            'link_type[0]' => 'links',
            'link_type[1]' => 'one_links',
            'short_urls' => '',
            'countries' => '',
            'referrers' => '',
            'visit_type' => '',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/team/clicks'
params = {
  'start_date': '2026-11-01T00:00:00Z',
  'end_date': '2026-11-07T12:00:00Z',
  'cursor': '',
  'limit': '50',
  'link_type[0]': 'links',
  'link_type[1]': 'one_links',
  'short_urls': '',
  'countries': '',
  'referrers': '',
  'visit_type': '',
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Send a real request with your own token.

Try List team visits

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

start_date

end_date

cursor

limit

link_type comma-separated

short_urls comma-separated

countries comma-separated

referrers comma-separated

visit_type comma-separated

Response

{
    "data": [
        {
            "key": "links:123",
            "link_type": "links",
            "created_at": "2026-11-07T10:00:00+00:00",
            "short_url": "https://t.ly/fall-sale",
            "destination": "https://example.com/sale",
            "country_code": "US",
            "city": "New York City",
            "region": "NY",
            "referrer": "google.com",
            "browser": "Chrome",
            "platform": "Mac OS",
            "language": "en",
            "qr_code": false,
            "user_agent": "Mozilla/5.0"
        }
    ],
    "next_cursor": null,
    "earliest_available": "2026-11-02T00:00:00+00:00"
}

{
    "message": "Invalid cursor."
}

{
    "message": "This search is taking too long. Try a shorter date range.",
    "timed_out": true
}

Query parameters

start_date string

Start timestamp, inclusive. Times are interpreted as UTC when no offset is supplied. Values older than your plan retention are clipped to earliest_available. With no dates, all retained visits are eligible. With only end_date, the start defaults to 24 hours ago.

Example: 2026-11-01T00:00:00Z
end_date string

End timestamp, inclusive. Defaults to now; future timestamps are clipped to now. Keep the same start and end values for every page.

Example: 2026-11-07T12:00:00Z
cursor string

Opaque next_cursor from the previous page. Omit on the first request. Do not construct or modify it.
limit integer

Visits per page, from 1 to 200. Defaults to 50.

Example: 50
link_type array of strings

Include links, one_links, or both. Defaults to both.

Example: ["links","one_links"]
short_urls array of strings

Only these short URLs. Up to 20.
countries array of strings

Country codes, up to 20. For example, US.
referrers array of strings

Referrer values, up to 20. Use Direct for missing or unknown referrers.
visit_type array of strings

Include visit, qr, or both. Omit for both. A visit is a regular link click; qr means a QR scan.

Pixels

Retargeting pixels that fire when someone visits a link.

Create a pixel

POST https://api.t.ly/api/v1/link/pixel

Creates a retargeting pixel you can add to links.

500/minute · Shared general limit Needs an API token

Request

curl -X POST https://api.t.ly/api/v1/link/pixel \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "GTMPixel",
    "pixel_id": "GTM-ABC1234",
    "pixel_type": "googleTagManager"
}'

const url = new URL(
    "https://api.t.ly/api/v1/link/pixel"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "GTMPixel",
    "pixel_id": "GTM-ABC1234",
    "pixel_type": "googleTagManager"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/link/pixel';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'GTMPixel',
            'pixel_id' => 'GTM-ABC1234',
            'pixel_type' => 'googleTagManager',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/link/pixel'
payload = {
    "name": "GTMPixel",
    "pixel_id": "GTM-ABC1234",
    "pixel_type": "googleTagManager"
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Send a real request with your own token.

Try Create a pixel

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

Body JSON

Response

{
    "id": 12345,
    "name": "GTMPixel",
    "pixel_id": "GTM-ABC1234",
    "pixel_type": "googleTagManager",
    "created_at": "2024-01-16T19:32:20.000000Z",
    "updated_at": "2024-01-16T19:32:20.000000Z"
}

Body parameters

name string Required

The pixel name, up to 50 characters.

Example: GTMPixel
pixel_id string Required

The provider identifier, up to 50 characters. Use a numeric ID for facebook, bing, linkedIn or pinterest; AW-123456789 or GT-XXXXXXXXX for googleAds; GTM-XXXXXXX for googleTagManager; G-XXXXXXXXXX for googleAnalytics; hexadecimal for quora; a UUID for snapchat; or an alphanumeric ID for twitter and tiktok.

Example: GTM-ABC1234
pixel_type string Required

The provider key. Values are case-sensitive. twitter is the X pixel; facebook is the Meta pixel.

One of facebookgoogleAdsgoogleTagManagergoogleAnalyticstwitterbingquoratiktoklinkedInpinterestsnapchat

List pixels

GET https://api.t.ly/api/v1/link/pixel

Returns all of your team's pixels.

500/minute · Shared general limit Needs an API token

Request

curl -X GET https://api.t.ly/api/v1/link/pixel \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/link/pixel"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/link/pixel';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/link/pixel'
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.request('GET', url, headers=headers)
response.json()

Send a real request with your own token.

Try List pixels

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

Response

[
    {
        "id": 12345,
        "name": "GTM Pixel",
        "pixel_id": "GTM-ABC1234",
        "pixel_type": "googleTagManager",
        "created_at": "2024-01-16T19:32:20.000000Z",
        "updated_at": "2024-01-16T19:32:20.000000Z"
    }
]

No parameters.

Get a pixel

GET https://api.t.ly/api/v1/link/pixel/{id}

Returns one retargeting pixel.

500/minute · Shared general limit Needs an API token

Request

curl -X GET https://api.t.ly/api/v1/link/pixel/12345 \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/link/pixel/12345"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/link/pixel/12345';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/link/pixel/12345'
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Send a real request with your own token.

Try Get a pixel

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

id in the URL

Response

{
    "id": 12345,
    "name": "GTMPixel",
    "pixel_id": "GTM-ABC1234",
    "pixel_type": "googleTagManager",
    "created_at": "2024-01-16T19:32:20.000000Z",
    "updated_at": "2024-01-16T19:32:20.000000Z"
}

URL parameters

id integer Required

The retargeting pixel's ID.

Example: 12345

Update a pixel

PUT https://api.t.ly/api/v1/link/pixel/{id}

Changes a retargeting pixel.

500/minute · Shared general limit Needs an API token

Request

curl -X PUT https://api.t.ly/api/v1/link/pixel/12345 \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "GTMPixel",
    "pixel_id": "GTM-ABC1234",
    "pixel_type": "googleTagManager"
}'

const url = new URL(
    "https://api.t.ly/api/v1/link/pixel/12345"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "GTMPixel",
    "pixel_id": "GTM-ABC1234",
    "pixel_type": "googleTagManager"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/link/pixel/12345';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'GTMPixel',
            'pixel_id' => 'GTM-ABC1234',
            'pixel_type' => 'googleTagManager',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/link/pixel/12345'
payload = {
    "name": "GTMPixel",
    "pixel_id": "GTM-ABC1234",
    "pixel_type": "googleTagManager"
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Send a real request with your own token.

Try Update a pixel

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

id in the URL

Body JSON

Response

{
    "id": 12345,
    "name": "GTMPixel",
    "pixel_id": "GTM-ABC1234",
    "pixel_type": "googleTagManager",
    "created_at": "2024-01-16T19:32:20.000000Z",
    "updated_at": "2024-01-16T19:32:20.000000Z"
}

URL parameters

id integer Required

The retargeting pixel's ID.

Example: 12345

Body parameters

name string Required

The pixel name, up to 50 characters.

Example: GTMPixel
pixel_id string Required

The provider identifier, up to 50 characters. Use a numeric ID for facebook, bing, linkedIn or pinterest; AW-123456789 or GT-XXXXXXXXX for googleAds; GTM-XXXXXXX for googleTagManager; G-XXXXXXXXXX for googleAnalytics; hexadecimal for quora; a UUID for snapchat; or an alphanumeric ID for twitter and tiktok.

Example: GTM-ABC1234
pixel_type string Required

The provider key. Values are case-sensitive. twitter is the X pixel; facebook is the Meta pixel.

One of facebookgoogleAdsgoogleTagManagergoogleAnalyticstwitterbingquoratiktoklinkedInpinterestsnapchat

Delete a pixel

DELETE https://api.t.ly/api/v1/link/pixel/{id}

Deletes a retargeting pixel. Links that used it keep working.

500/minute · Shared general limit Needs an API token

Request

curl -X DELETE https://api.t.ly/api/v1/link/pixel/12345 \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/link/pixel/12345"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/link/pixel/12345';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/link/pixel/12345'
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Send a real request with your own token.

Try Delete a pixel

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

id in the URL

Response

No content

URL parameters

id integer Required

The retargeting pixel's ID.

Example: 12345

UTM presets

Saved sets of UTM parameters to add to long URLs.

Create a UTM preset

POST https://api.t.ly/api/v1/link/utm-preset

Creates a UTM preset you can add to links. Include at least one non-empty UTM value.

500/minute · Shared general limit Needs an API token

Request

curl -X POST https://api.t.ly/api/v1/link/utm-preset \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Newsletter Launch",
    "source": "newsletter",
    "medium": "email",
    "campaign": "fall_launch",
    "content": "hero-cta",
    "term": "running-shoes"
}'

const url = new URL(
    "https://api.t.ly/api/v1/link/utm-preset"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Newsletter Launch",
    "source": "newsletter",
    "medium": "email",
    "campaign": "fall_launch",
    "content": "hero-cta",
    "term": "running-shoes"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/link/utm-preset';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'Newsletter Launch',
            'source' => 'newsletter',
            'medium' => 'email',
            'campaign' => 'fall_launch',
            'content' => 'hero-cta',
            'term' => 'running-shoes',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/link/utm-preset'
payload = {
    "name": "Newsletter Launch",
    "source": "newsletter",
    "medium": "email",
    "campaign": "fall_launch",
    "content": "hero-cta",
    "term": "running-shoes"
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Send a real request with your own token.

Try Create a UTM preset

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

Body JSON

Response

{
    "id": 12345,
    "name": "Newsletter Launch",
    "source": "newsletter",
    "medium": "email",
    "campaign": "fall_launch",
    "content": "hero-cta",
    "term": "running-shoes",
    "created_at": "2026-03-18T12:00:00.000000Z",
    "updated_at": "2026-03-18T12:00:00.000000Z"
}

Body parameters

name string Required

The preset name, up to 80 characters.

Example: Newsletter Launch
source string

The UTM source value, up to 255 characters.

Example: newsletter
medium string

The UTM medium value, up to 255 characters.

Example: email
campaign string

The UTM campaign value, up to 255 characters.

Example: fall_launch
content string

The UTM content value, up to 255 characters.

Example: hero-cta
term string

The UTM term value, up to 255 characters.

Example: running-shoes

List UTM presets

GET https://api.t.ly/api/v1/link/utm-preset

Returns all of your team's UTM presets.

500/minute · Shared general limit Needs an API token

Request

curl -X GET https://api.t.ly/api/v1/link/utm-preset \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/link/utm-preset"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/link/utm-preset';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/link/utm-preset'
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.request('GET', url, headers=headers)
response.json()

Send a real request with your own token.

Try List UTM presets

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

Response

[
    {
        "id": 12345,
        "name": "Newsletter Launch",
        "source": "newsletter",
        "medium": "email",
        "campaign": "fall_launch",
        "content": "hero-cta",
        "term": "running-shoes",
        "created_at": "2026-03-18T12:00:00.000000Z",
        "updated_at": "2026-03-18T12:00:00.000000Z"
    }
]

No parameters.

Get a UTM preset

GET https://api.t.ly/api/v1/link/utm-preset/{id}

Returns one UTM preset.

500/minute · Shared general limit Needs an API token

Request

curl -X GET https://api.t.ly/api/v1/link/utm-preset/12345 \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/link/utm-preset/12345"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/link/utm-preset/12345';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/link/utm-preset/12345'
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN',
  'Content-Type': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Send a real request with your own token.

Try Get a UTM preset

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

id in the URL

Response

{
    "id": 12345,
    "name": "Newsletter Launch",
    "source": "newsletter",
    "medium": "email",
    "campaign": "fall_launch",
    "content": "hero-cta",
    "term": "running-shoes",
    "created_at": "2026-03-18T12:00:00.000000Z",
    "updated_at": "2026-03-18T12:00:00.000000Z"
}

URL parameters

id integer Required

The UTM preset's ID.

Example: 12345

Update a UTM preset

PUT https://api.t.ly/api/v1/link/utm-preset/{id}

Changes a UTM preset. Include at least one non-empty UTM value. Omitted UTM values are cleared.

500/minute · Shared general limit Needs an API token

Request

curl -X PUT https://api.t.ly/api/v1/link/utm-preset/12345 \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Newsletter Launch",
    "source": "newsletter",
    "medium": "email",
    "campaign": "fall_launch",
    "content": "hero-cta",
    "term": "running-shoes"
}'

const url = new URL(
    "https://api.t.ly/api/v1/link/utm-preset/12345"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Newsletter Launch",
    "source": "newsletter",
    "medium": "email",
    "campaign": "fall_launch",
    "content": "hero-cta",
    "term": "running-shoes"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/link/utm-preset/12345';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'Newsletter Launch',
            'source' => 'newsletter',
            'medium' => 'email',
            'campaign' => 'fall_launch',
            'content' => 'hero-cta',
            'term' => 'running-shoes',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/link/utm-preset/12345'
payload = {
    "name": "Newsletter Launch",
    "source": "newsletter",
    "medium": "email",
    "campaign": "fall_launch",
    "content": "hero-cta",
    "term": "running-shoes"
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Send a real request with your own token.

Try Update a UTM preset

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

id in the URL

Body JSON

Response

{
    "id": 12345,
    "name": "Newsletter Launch",
    "source": "newsletter",
    "medium": "email",
    "campaign": "fall_launch",
    "content": "hero-cta",
    "term": "running-shoes",
    "created_at": "2026-03-18T12:00:00.000000Z",
    "updated_at": "2026-03-18T12:00:00.000000Z"
}

URL parameters

id integer Required

The UTM preset's ID.

Example: 12345

Body parameters

name string Required

The preset name, up to 80 characters.

Example: Newsletter Launch
source string

The UTM source value, up to 255 characters.

Example: newsletter
medium string

The UTM medium value, up to 255 characters.

Example: email
campaign string

The UTM campaign value, up to 255 characters.

Example: fall_launch
content string

The UTM content value, up to 255 characters.

Example: hero-cta
term string

The UTM term value, up to 255 characters.

Example: running-shoes

Delete a UTM preset

DELETE https://api.t.ly/api/v1/link/utm-preset/{id}

Deletes a UTM preset. Links that used it keep working.

500/minute · Shared general limit Needs an API token

Request

curl -X DELETE https://api.t.ly/api/v1/link/utm-preset/12345 \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/link/utm-preset/12345"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/link/utm-preset/12345';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
            'Content-Type' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/link/utm-preset/12345'
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN',
  'Content-Type': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Send a real request with your own token.

Try Delete a UTM preset

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

id in the URL

Response

No content

URL parameters

id integer Required

The UTM preset's ID.

Example: 12345

Account and usage

Check your token's account, find team members and monitor plan allowances.

Get the current user

GET https://api.t.ly/api/v1/account/user

Returns the name and email of the user associated with the API token.

500/minute · Shared general limit Needs an API token

Request

curl -X GET https://api.t.ly/api/v1/account/user \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/account/user"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/account/user';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/account/user'
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.request('GET', url, headers=headers)
response.json()

Send a real request with your own token.

Try Get the current user

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

Response

{
    "name": "Alex Morgan",
    "email": "[email protected]"
}

No parameters.

List team members

GET https://api.t.ly/api/v1/account/team-members

Returns members of the token's team, sorted by name. Use their id values in the user_ids filter on link lists and team analytics. The response contains names and email addresses; keep it within your integration.

500/minute · Shared general limit Needs an API token

Request

curl -X GET https://api.t.ly/api/v1/account/team-members \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/account/team-members"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/account/team-members';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/account/team-members'
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.request('GET', url, headers=headers)
response.json()

Send a real request with your own token.

Try List team members

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

Response

{
    "users": [
        {
            "id": 123,
            "name": "Alex Morgan",
            "email": "[email protected]"
        }
    ]
}

No parameters.

Get team usage

GET https://api.t.ly/api/v1/account/usage

Returns usage and plan allowances for the token's team in one request. Each resource has an integer used count and limit, including team-specific allowances. monthly.links counts short links created in the app or API during the calendar month; monthly.analytics counts tracked analytics events. These reset at monthly.resets_at in UTC. Custom domains (including pending domains), OneLinks and team members are current resource counts and do not reset monthly. Team members include the owner and exclude pending invitations. A zero limit means no allowance is configured. These allowances are separate from HTTP request rate limits. Usage totals may be cached for a short period, so recent activity may take time to appear. The top-level link and click totals cover short links only; current_month_clicks includes this month's visits to older links.

500/minute · Shared general limit Needs an API token

Request

curl -X GET https://api.t.ly/api/v1/account/usage \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/account/usage"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/account/usage';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/account/usage'
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.request('GET', url, headers=headers)
response.json()

Send a real request with your own token.

Try Get team usage

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

Response

{
    "monthly": {
        "starts_at": "2026-11-01T00:00:00+00:00",
        "resets_at": "2026-12-01T00:00:00+00:00",
        "links": {
            "used": 12,
            "limit": 1000
        },
        "analytics": {
            "used": 150,
            "limit": 10000
        }
    },
    "custom_domains": {
        "used": 2,
        "limit": 5
    },
    "one_links": {
        "used": 1,
        "limit": 5
    },
    "team_members": {
        "used": 3,
        "limit": 5
    },
    "current_month_links": 12,
    "current_month_clicks": 150,
    "total_links": 80,
    "total_clicks": 2400
}

No parameters.

Domains

Find your team's branded domain URLs for link creation and filters.

List domains

GET https://api.t.ly/api/v1/domain/list

Returns verified custom domains belonging to the token's team. Use the domain URL when creating links or filtering short-link lists and team analytics. Include its scheme and trailing slash. Set include_non_verified=true to include pending domains; these are not verified for use yet. Set include_dns_info=true as well to include DNS details for pending domains. include_platform_domains=true adds selectable T.LY-owned domains; these have is_platform_domain: true and no custom domain ID. An empty array means no matching domains.

500/minute · Shared general limit Needs an API token

Request

curl -X GET 'https://api.t.ly/api/v1/domain/list?include_non_verified=0&include_dns_info=0&include_platform_domains=0' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/domain/list"
);

const params = {
    "include_non_verified": "0",
    "include_dns_info": "0",
    "include_platform_domains": "0",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/domain/list';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
        ],
        'query' => [
            'include_non_verified' => '0',
            'include_dns_info' => '0',
            'include_platform_domains' => '0',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/domain/list'
params = {
  'include_non_verified': '0',
  'include_dns_info': '0',
  'include_platform_domains': '0',
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Send a real request with your own token.

Try List domains

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

include_non_verified

include_dns_info

include_platform_domains

Response

[
    {
        "id": 123,
        "team_id": 456,
        "domain": "https://go.example.com/",
        "fallback_url": "https://example.com/",
        "aname_validated": null,
        "cname_validated": "2026-11-01 12:00:00",
        "is_case_sensitive": false,
        "created_at": "2026-11-01T12:00:00.000000Z",
        "updated_at": "2026-11-01T12:00:00.000000Z"
    }
]

Query parameters

include_non_verified boolean

Include unverified team domains. Defaults to false.

Example: false
include_dns_info boolean

Include DNS records and setup instructions for pending domains. Use with include_non_verified. Defaults to false.

Example: false
include_platform_domains boolean

Also include selectable T.LY-owned domains. Defaults to false.

Example: false

Webhooks

For most integrations, configure webhooks in Settings and receive events in your app. These optional endpoints automate subscription and delivery management.

Set up and receive webhook events

Create a webhook

POST https://api.t.ly/api/v1/webhook

Creates an event subscription. Store the returned secret immediately; it is shown only on creation or rotation. Your receiver must accept JSON POST requests and return 2xx. Requires a Business plan with webhook access. All operations use the token's team. See the webhook setup guide for payloads, X-Tly-Key verification, retries and delivery limits. Deliveries can be skipped when the team delivery rate limit is reached; this is separate from API request throttling. The legacy event response field is the first entry in events.

500/minute · Shared general limit Needs an API token

Request

curl -X POST https://api.t.ly/api/v1/webhook \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Campaign visits",
    "url": "https://example.com/webhooks",
    "events": [
        "short_link.visited"
    ],
    "is_active": true,
    "tags": []
}'

const url = new URL(
    "https://api.t.ly/api/v1/webhook"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Campaign visits",
    "url": "https:\/\/example.com\/webhooks",
    "events": [
        "short_link.visited"
    ],
    "is_active": true,
    "tags": []
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/webhook';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'Campaign visits',
            'url' => 'https://example.com/webhooks',
            'events' => [
                'short_link.visited',
            ],
            'is_active' => true,
            'tags' => [],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/webhook'
payload = {
    "name": "Campaign visits",
    "url": "https:\/\/example.com\/webhooks",
    "events": [
        "short_link.visited"
    ],
    "is_active": true,
    "tags": []
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Send a real request with your own token.

Try Create a webhook

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

Body JSON

Response

{
    "id": 123,
    "name": "Campaign visits",
    "url": "https://example.com/webhooks",
    "event": "short_link.visited",
    "events": [
        "short_link.visited"
    ],
    "tags": [],
    "is_active": true,
    "last_success_at": null,
    "last_failure_at": null,
    "created_at": "2026-11-07T10:00:00.000000Z",
    "updated_at": "2026-11-07T10:00:00.000000Z",
    "secret": "YOUR_WEBHOOK_SECRET"
}

Body parameters

name string Required

Webhook name, up to 100 characters.

Example: Campaign visits
url string Required

Your receiver URL. Must use HTTPS and resolve to a public hostname; redirects and IP-literal URLs are not supported. Up to 2000 characters.

Example: https://example.com/webhooks
events array of strings Required

Events to subscribe to: short_link.visited, one_link.visited, one_link.link_visited. Send at least one and at most 10.

Example: ["short_link.visited"]
is_active boolean

Enable deliveries. Defaults to true on creation.

Example: true
tags array of integers

Only deliver events for links with any of these team tag IDs. Up to 50. An empty array matches all tags.

List webhooks

GET https://api.t.ly/api/v1/webhook

Returns all webhook subscriptions for your team. Secrets are omitted. An empty array means none are configured. Requires a Business plan with webhook access. All operations use the token's team. See the webhook setup guide for payloads, X-Tly-Key verification, retries and delivery limits. Deliveries can be skipped when the team delivery rate limit is reached; this is separate from API request throttling. The legacy event response field is the first entry in events.

500/minute · Shared general limit Needs an API token

Request

curl -X GET https://api.t.ly/api/v1/webhook \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/webhook"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/webhook';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/webhook'
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.request('GET', url, headers=headers)
response.json()

Send a real request with your own token.

Try List webhooks

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

Response

[
    {
        "id": 123,
        "name": "Campaign visits",
        "url": "https://example.com/webhooks",
        "event": "short_link.visited",
        "events": [
            "short_link.visited"
        ],
        "tags": [],
        "is_active": true,
        "last_success_at": null,
        "last_failure_at": null,
        "created_at": "2026-11-07T10:00:00.000000Z",
        "updated_at": "2026-11-07T10:00:00.000000Z"
    }
]

No parameters.

Get a webhook

GET https://api.t.ly/api/v1/webhook/{id}

Returns one subscription. Its secret is omitted. Returns 404 when the webhook does not belong to the team. Requires a Business plan with webhook access. All operations use the token's team. See the webhook setup guide for payloads, X-Tly-Key verification, retries and delivery limits. Deliveries can be skipped when the team delivery rate limit is reached; this is separate from API request throttling. The legacy event response field is the first entry in events.

500/minute · Shared general limit Needs an API token

Request

curl -X GET https://api.t.ly/api/v1/webhook/123 \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/webhook/123"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/webhook/123';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/webhook/123'
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.request('GET', url, headers=headers)
response.json()

Send a real request with your own token.

Try Get a webhook

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

id in the URL

Response

{
    "id": 123,
    "name": "Campaign visits",
    "url": "https://example.com/webhooks",
    "event": "short_link.visited",
    "events": [
        "short_link.visited"
    ],
    "tags": [],
    "is_active": true,
    "last_success_at": null,
    "last_failure_at": null,
    "created_at": "2026-11-07T10:00:00.000000Z",
    "updated_at": "2026-11-07T10:00:00.000000Z"
}

URL parameters

id integer Required

Webhook ID returned by Create or List webhooks.

Example: 123

Update a webhook

PUT https://api.t.ly/api/v1/webhook/{id}

Changes only the supplied fields. Send tags: [] to remove tag filters. If events is supplied, it replaces the entire subscription list and must not be empty. The response includes secret only when rotate_secret is true. Requires a Business plan with webhook access. All operations use the token's team. See the webhook setup guide for payloads, X-Tly-Key verification, retries and delivery limits. Deliveries can be skipped when the team delivery rate limit is reached; this is separate from API request throttling. The legacy event response field is the first entry in events.

500/minute · Shared general limit Needs an API token

Request

curl -X PUT https://api.t.ly/api/v1/webhook/123 \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Campaign visits",
    "url": "https://example.com/webhooks",
    "events": [
        "short_link.visited"
    ],
    "is_active": true,
    "tags": [],
    "rotate_secret": false
}'

const url = new URL(
    "https://api.t.ly/api/v1/webhook/123"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Campaign visits",
    "url": "https:\/\/example.com\/webhooks",
    "events": [
        "short_link.visited"
    ],
    "is_active": true,
    "tags": [],
    "rotate_secret": false
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/webhook/123';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'name' => 'Campaign visits',
            'url' => 'https://example.com/webhooks',
            'events' => [
                'short_link.visited',
            ],
            'is_active' => true,
            'tags' => [],
            'rotate_secret' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/webhook/123'
payload = {
    "name": "Campaign visits",
    "url": "https:\/\/example.com\/webhooks",
    "events": [
        "short_link.visited"
    ],
    "is_active": true,
    "tags": [],
    "rotate_secret": false
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Send a real request with your own token.

Try Update a webhook

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

id in the URL

Body JSON

Response

{
    "id": 123,
    "name": "Campaign visits",
    "url": "https://example.com/webhooks",
    "event": "short_link.visited",
    "events": [
        "short_link.visited"
    ],
    "tags": [],
    "is_active": true,
    "last_success_at": null,
    "last_failure_at": null,
    "created_at": "2026-11-07T10:00:00.000000Z",
    "updated_at": "2026-11-07T10:00:00.000000Z"
}

{
    "id": 123,
    "name": "Campaign visits",
    "url": "https://example.com/webhooks",
    "event": "short_link.visited",
    "events": [
        "short_link.visited"
    ],
    "tags": [],
    "is_active": true,
    "last_success_at": null,
    "last_failure_at": null,
    "created_at": "2026-11-07T10:00:00.000000Z",
    "updated_at": "2026-11-07T10:00:00.000000Z",
    "secret": "YOUR_NEW_WEBHOOK_SECRET"
}

URL parameters

id integer Required

Webhook ID returned by Create or List webhooks.

Example: 123

Body parameters

name string

Webhook name, up to 100 characters.

Example: Campaign visits
url string

Your receiver URL. Must use HTTPS and resolve to a public hostname; redirects and IP-literal URLs are not supported. Up to 2000 characters.

Example: https://example.com/webhooks
events array of strings

Events to subscribe to: short_link.visited, one_link.visited, one_link.link_visited. Send at least one and at most 10.

Example: ["short_link.visited"]
is_active boolean

Enable deliveries. Defaults to true on creation.

Example: true
tags array of integers

Only deliver events for links with any of these team tag IDs. Up to 50. An empty array matches all tags.
rotate_secret boolean

Replace the secret. The new secret is returned only in this response; update your receiver before accepting subsequent deliveries.

Example: false

Delete a webhook

DELETE https://api.t.ly/api/v1/webhook/{id}

Deletes this subscription. Returns 202 with an empty body. Requires a Business plan with webhook access. All operations use the token's team. See the webhook setup guide for payloads, X-Tly-Key verification, retries and delivery limits. Deliveries can be skipped when the team delivery rate limit is reached; this is separate from API request throttling. The legacy event response field is the first entry in events.

500/minute · Shared general limit Needs an API token

Request

curl -X DELETE https://api.t.ly/api/v1/webhook/123 \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/webhook/123"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json",
};


fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/webhook/123';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/webhook/123'
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Send a real request with your own token.

Try Delete a webhook

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

id in the URL

Response

No content

URL parameters

id integer Required

Webhook ID returned by Create or List webhooks.

Example: 123

Send a test webhook

POST https://api.t.ly/api/v1/webhook/{id}/test

Requests a test delivery for the first subscribed event and returns 202 with an empty body without waiting for delivery. Set sync=true to attempt delivery before returning a JSON delivery result with HTTP 200. A 200 response does not itself mean delivery succeeded: check status and response_status. Synchronous network or receiver failures can return an error instead of a delivery result; inspect delivery logs after a failed test. Requires a Business plan with webhook access. All operations use the token's team. See the webhook setup guide for payloads, X-Tly-Key verification, retries and delivery limits. Deliveries can be skipped when the team delivery rate limit is reached; this is separate from API request throttling. The legacy event response field is the first entry in events.

500/minute · Shared general limit Needs an API token

Request

curl -X POST https://api.t.ly/api/v1/webhook/123/test \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "sync": false
}'

const url = new URL(
    "https://api.t.ly/api/v1/webhook/123/test"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "sync": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/webhook/123/test';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'sync' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/webhook/123/test'
payload = {
    "sync": false
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Send a real request with your own token.

Try Send a test webhook

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

id in the URL

Body JSON

Response

No content

{
    "id": 456,
    "status": "success",
    "response_status": 204,
    "response_body": "",
    "error_message": null,
    "created_at": "2026-11-07T10:00:00.000000Z"
}

URL parameters

id integer Required

Webhook ID returned by Create or List webhooks.

Example: 123

Body parameters

sync boolean

Wait for a delivery result before responding. Defaults to false.

Example: false

List webhook deliveries

GET https://api.t.ly/api/v1/webhook/logs

Returns delivery attempts, newest first, with success, failed or skipped status. Retries can create separate rows with different attempt values. Logs are retained for seven days. Use page while current_page < last_page. The list omits payloads, response bodies and secrets. Requires a Business plan with webhook access. All operations use the token's team. See the webhook setup guide for payloads, X-Tly-Key verification, retries and delivery limits. Deliveries can be skipped when the team delivery rate limit is reached; this is separate from API request throttling. The legacy event response field is the first entry in events.

500/minute · Shared general limit Needs an API token

Request

curl -X GET 'https://api.t.ly/api/v1/webhook/logs?limit=25&page=1' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/webhook/logs"
);

const params = {
    "webhook_id": "",
    "limit": "25",
    "page": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/webhook/logs';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
        ],
        'query' => [
            'webhook_id' => '',
            'limit' => '25',
            'page' => '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/webhook/logs'
params = {
  'webhook_id': '',
  'limit': '25',
  'page': '1',
}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Send a real request with your own token.

Try List webhook deliveries

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

webhook_id

limit

page

Response

{
    "data": [
        {
            "id": 456,
            "webhook_id": 123,
            "webhook_name": "Campaign visits",
            "event": "short_link.visited",
            "status": "success",
            "response_status": 204,
            "error_message": null,
            "attempt": 1,
            "is_test": false,
            "created_at": "2026-11-07T10:00:00.000000Z"
        }
    ],
    "meta": {
        "current_page": 1,
        "last_page": 1,
        "per_page": 25,
        "total": 1
    }
}

Query parameters

webhook_id integer

Only attempts for this webhook ID.
limit integer

Rows per page, from 1 to 100. Defaults to 25.

Example: 25
page integer

Page number, starting at 1.

Example: 1

Resend a webhook delivery

POST https://api.t.ly/api/v1/webhook/logs/{id}/resend

Resends the original event using the webhook's current settings. This sends a new delivery and can repeat a downstream action; use it deliberately. Returns 202 with an empty body. Returns 404 if the log or its webhook no longer exists, or 409 if the webhook is disabled. Requires a Business plan with webhook access. All operations use the token's team. See the webhook setup guide for payloads, X-Tly-Key verification, retries and delivery limits. Deliveries can be skipped when the team delivery rate limit is reached; this is separate from API request throttling. The legacy event response field is the first entry in events.

500/minute · Shared general limit Needs an API token

Request

curl -X POST https://api.t.ly/api/v1/webhook/logs/456/resend \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const url = new URL(
    "https://api.t.ly/api/v1/webhook/logs/456/resend"
);

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json",
};


fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://api.t.ly/api/v1/webhook/logs/456/resend';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer YOUR_API_TOKEN',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.t.ly/api/v1/webhook/logs/456/resend'
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.request('POST', url, headers=headers)
response.json()

Send a real request with your own token.

Try Resend a webhook delivery

This sends a real request to api.t.ly with your token. Anything it creates, changes or deletes is real.

API token

id in the URL

Response

No content

{
    "message": "Webhook is disabled."
}

URL parameters

id integer Required

Delivery log ID from List webhook deliveries, not the webhook ID.

Example: 456

Still stuck?

Email [email protected], or connect without code using Zapier, Google Sheets and more.

Contact support

Last updated: November 8, 2026

T.LY API

Quick start

Create a token

Send it with every request

Shorten a link

API reference

Authentication

Rate limits and errors

Monthly link allowance

When to retry

Error responses

More ways to connect

Try Create a short link

Body parameters

Try List short links

Query parameters

Try Expand a short link

Body parameters

Try Bulk shorten links

Body parameters

Try Bulk update links

Body parameters

Try Get a short link

Query parameters

Try Update a short link

Body parameters

Try Delete a short link

Body parameters

Try Get link stats

Query parameters

Try Get bulk job status

URL parameters

Try List failed bulk rows

URL parameters

Query parameters

Try Get a QR code

Query parameters

Try Update a QR code

Body parameters

Try List OneLinks

Query parameters

Try Get OneLink stats

Query parameters

Try Get team visits

Query parameters

Try Get daily team visits

Query parameters

Try List top team links

Query parameters

Try Get team countries

Query parameters

Try Get team cities

Query parameters

Try Get team referrers

Query parameters

Try Get team platforms

Query parameters

Try Get team browsers

Query parameters

Try Get team languages

Query parameters

Try List team visits

Query parameters

Try Create a tag

Body parameters

Try List tags

Try Get a tag

URL parameters

Try Update a tag

URL parameters

Body parameters

Try Delete a tag

URL parameters

Try Create a pixel

Body parameters

Try List pixels

Try Get a pixel

URL parameters

Try Update a pixel

URL parameters