Tài liệu API
SHORTEN WORLD's API biểu thị toàn bộ SHORTEN WORLD nền tảng thông qua giao diện lập trình được tiêu chuẩn hóa. Sử dụng SHORTEN WORLD API, bạn có thể làm bất cứ điều gì giống như trên shortenworld.com bảng điều khiển có thể làm.
SHORTEN WORLD API sử dụng RESTful API dựa trên HTTPS và định dạng JSON. Nếu bạn đã có tài khoản SHORTEN WORLD, bạn có thể lấy khóa API của mình từ đầu trang "Khóa API", được tìm thấy tại đây:
Đi tới tài khoản của tôi
Endpoints
API được truy cập thông qua HTTPS đến một URL cụ thể được đánh phiên bản (version), bao gồm các phương thức GET, POST, PUT, PATCH, và DELETE. Mỗi một endpoint chỉ được truy cập thông qua giao thức SSL HTTPS (cổng 443).
Mọi thứ (phương thức, các tham số, ...) được cố định tại các phiên bản, và mỗi lệnh gọi phải chứa một phiên bản. Phiên bản hiện tại là Version 1.
URL cho phiên bản ổn định version 1 là:
https://api.shortenworld.com/v1/
Danh sách API
Lấy token
Làm mới token
Vô hiệu token
Lấy danh sách nhóm
Lấy danh sách chiến dịch
Lấy các tên miền được đăng ký
Lấy danh sách liên kết
Tạo liên kết
Cập nhật liên kết
Xóa liên kết
Chuyển hướng liên kết
Chuyển hướng liên kết điện thoại
Liên kết hết hạn
Mật khẩu liên kết
Lấy danh sách công cụ theo dõi
Lấy danh sách công cụ theo dõi của nhóm
Lấy danh sách công cụ theo dõi của liên kết
Tạo công cụ theo dõi của liên kết
Xóa công cụ theo dõi của liên kết
Thử nghiệm liên kết A/B/C/D/E/F...
Phân tích liên kết
Giới hạn API
Lấy token
Trước hết, chúng ta cần sử dụng API này để xác thực và nhận mã token. Chúng ta sẽ sử dụng mã token này để xác thực tất cả các API khác.
Sử dụng access_token
để xác thực tất cả các API khác, và sử dụng refresh_token
để lấy access_token
mới mà không cần đăng nhập lại
Headers bắt buộc
Content-Type |
[String, Bắt buộc]. Giá trị là: application/json |
Các tham số
username |
[String, Bắt buộc]. Username của bạn (không phải email). |
key |
[String, Bắt buộc]. Khóa API của bạn. |
Ví dụ
Để xem chuỗi JSON đẹp hơn, chúng ta có thể sử dụng công cụ định dạng: https://format.asia/json-format
HTTP Status
200 |
Thành công |
401 |
Không có quyền truy cập |
403 |
Tài khoản của bạn bị khóa hoặc quyền bị từ chối |
429 |
Đăng nhập quá nhiều lần không thành công |
500 |
Một lỗi không xác định |
Chuỗi json được trả về, chứa các thông tin sau
status => code: 0 |
Thành công |
status => code: not equal 0 |
Lỗi |
status => message |
Thông báo lỗi |
status => timestamp |
Thời gian phản hồi của máy chủ |
Nếu HTTP Status là 200 và status => code
bằng 0, thì
token => access_token |
Sử dụng access_token này để xác thực các API khác. Nó sẽ hết hạn sau 01 giờ |
token => refresh_token |
Sử dụng refresh_token để lấy về một access_token mới mà không cần đăng nhập lại. Nó sẽ hết hạn sau 07 ngày |
token => expires_in |
Thời gian còn lại (bằng giây) mà access_token còn hoạt động |
Làm mới token
Chúng ta sử dụng API này để lấy một token mới dựa trên refresh_token.
Headers bắt buộc
Content-Type |
[String, Bắt buộc]. Giá trị là: application/json |
Các tham số
refreshToken |
[String, Bắt buộc]. Lấy refresh_token từ kết quả trả về của API Lấy token. |
Ví dụ
Để xem chuỗi JSON đẹp hơn, chúng ta có thể sử dụng công cụ định dạng: https://format.asia/json-format
HTTP Status
200 |
Thành công |
401 |
Không có quyền truy cập |
403 |
Tài khoản của bạn bị khóa hoặc quyền bị từ chối |
429 |
Đăng nhập quá nhiều lần không thành công |
500 |
Một lỗi không xác định |
Chuỗi json được trả về, chứa các thông tin sau
status => code: 0 |
Thành công |
status => code: not equal 0 |
Lỗi |
status => message |
Thông báo lỗi |
status => timestamp |
Thời gian phản hồi của máy chủ |
Nếu HTTP Status là 200 và status => code
bằng 0, thì
token => access_token |
Sử dụng access_token này để xác thực các API khác. Nó sẽ hết hạn sau 01 giờ |
token => refresh_token |
Sử dụng refresh_token để lấy về một access_token mới mà không cần đăng nhập lại. Nó sẽ hết hạn sau 07 ngày |
token => expires_in |
Thời gian còn lại (bằng giây) mà access_token còn hoạt động |
Vô hiệu token
Chúng ta sử dụng API này để vô hiệu token.
Headers bắt buộc
Content-Type |
[String, Bắt buộc]. Giá trị là: application/json |
Authorization |
[String, Bắt buộc]]. Giá trị là: Bearer [access_token] |
Các tham số
Ví dụ
Để xem chuỗi JSON đẹp hơn, chúng ta có thể sử dụng công cụ định dạng: https://format.asia/json-format
HTTP Status
200 |
Thành công |
401 |
Không có quyền truy cập |
403 |
Tài khoản của bạn bị khóa hoặc quyền bị từ chối |
429 |
Đăng nhập quá nhiều lần không thành công |
500 |
Một lỗi không xác định |
Chuỗi json được trả về, chứa các thông tin sau
status => code: 0 |
Thành công |
status => code: not equal 0 |
Lỗi |
status => message |
Thông báo lỗi |
status => timestamp |
Thời gian phản hồi của máy chủ |
Lấy danh sách nhóm
Chúng ta sử dụng API này để lấy danh sách nhóm của bạn hoặc nhóm mà bạn là thành viên
Headers bắt buộc
Content-Type |
[String, Bắt buộc]. Giá trị là: application/json |
Authorization |
[String, Bắt buộc]]. Giá trị là: Bearer [access_token] |
Các tham số
size |
[Number, Không bắt buộc]. Số lượng kết quả mỗi trang, mặc định 20 kết quả. |
page |
[Number, Không bắt buộc]. Trang kết quả, mặc định là 0. Trang bắt đầu là 0. |
Ví dụ
Để xem chuỗi JSON đẹp hơn, chúng ta có thể sử dụng công cụ định dạng: https://format.asia/json-format
HTTP Status
200 |
Thành công |
401 |
Không có quyền truy cập |
403 |
Tài khoản của bạn bị khóa hoặc quyền bị từ chối |
429 |
Đăng nhập quá nhiều lần không thành công |
500 |
Một lỗi không xác định |
Chuỗi json được trả về, chứa các thông tin sau
status => code: 0 |
Thành công |
status => code: not equal 0 |
Lỗi |
status => message |
Thông báo lỗi |
status => timestamp |
Thời gian phản hồi của máy chủ |
Lấy danh sách chiến dịch
Chúng ta sử dụng API này để lấy tất cả danh sách các chiến dịch trong nhóm của bạn hoặc nhóm mà bạn làm thành viên
Headers bắt buộc
Content-Type |
[String, Bắt buộc]. Giá trị là: application/json |
Authorization |
[String, Bắt buộc]]. Giá trị là: Bearer [access_token] |
Các tham số
teamId |
[String, Không bắt buộc]. Lấy teamId từ API Lấy danh sách nhóm. Sẽ liệt kê tất cả các chiến dịch thuộc nhóm này, nếu không chỉ định nó sẽ trả về tất cả các chiến dịch của tất cả nhóm bạn đang quản lý. |
size |
[Number, Không bắt buộc]. Số lượng kết quả mỗi trang, mặc định 20 kết quả. |
page |
[Number, Không bắt buộc]. Trang kết quả, mặc định là 0. Trang bắt đầu là 0. |
Ví dụ
Để xem chuỗi JSON đẹp hơn, chúng ta có thể sử dụng công cụ định dạng: https://format.asia/json-format
HTTP Status
200 |
Thành công |
401 |
Không có quyền truy cập |
403 |
Tài khoản của bạn bị khóa hoặc quyền bị từ chối |
429 |
Đăng nhập quá nhiều lần không thành công |
500 |
Một lỗi không xác định |
Chuỗi json được trả về, chứa các thông tin sau
status => code: 0 |
Thành công |
status => code: not equal 0 |
Lỗi |
status => message |
Thông báo lỗi |
status => timestamp |
Thời gian phản hồi của máy chủ |
Lấy các tên miền được đăng ký
Chúng ta sử dụng API này để lấy tất cả các tên miền mà bạn đã đăng ký vào nhóm. Cả tên miền đi thuê và tên miền của riêng bạn
Headers bắt buộc
Content-Type |
[String, Bắt buộc]. Giá trị là: application/json |
Authorization |
[String, Bắt buộc]]. Giá trị là: Bearer [access_token] |
Các tham số
teamId |
[String, Bắt buộc]. Lấy teamId từ API Lấy danh sách nhóm. |
size |
[Number, Không bắt buộc]. Số lượng kết quả mỗi trang, mặc định 20 kết quả. |
page |
[Number, Không bắt buộc]. Trang kết quả, mặc định là 0. Trang bắt đầu là 0. |
Ví dụ
Để xem chuỗi JSON đẹp hơn, chúng ta có thể sử dụng công cụ định dạng: https://format.asia/json-format
HTTP Status
200 |
Thành công |
401 |
Không có quyền truy cập |
403 |
Tài khoản của bạn bị khóa hoặc quyền bị từ chối |
429 |
Đăng nhập quá nhiều lần không thành công |
500 |
Một lỗi không xác định |
Chuỗi json được trả về, chứa các thông tin sau
status => code: 0 |
Thành công |
status => code: not equal 0 |
Lỗi |
status => message |
Thông báo lỗi |
status => timestamp |
Thời gian phản hồi của máy chủ |
Lấy danh sách liên kết
Chúng ta sử dụng API này để lấy tất cả các liên kết thuộc về nhóm của bạn hoặc nhóm mà bạn là thành viên
Headers bắt buộc
Content-Type |
[String, Bắt buộc]. Giá trị là: application/json |
Authorization |
[String, Bắt buộc]]. Giá trị là: Bearer [access_token] |
Các tham số
teamId |
[String, Không bắt buộc]. Lấy teamId từ API Lấy danh sách nhóm. |
domainIds |
[Nhiều Strings. Cách nhau bởi dấy phẩy "," , Không bắt buộc]. Lấy domainId từ API Lấy các tên miền được đăng ký. |
campaignIds |
[Nhiều Strings. Cách nhau bởi dấy phẩy "," , Không bắt buộc]. Get campaignId from Get campaign list API. |
hidden |
[String, Không bắt buộc]. Giá trị là: true hoặc false. Nếu true, nó sẽ trả về tất cả các liên kết ẩn |
search |
[String, Không bắt buộc]. Tìm kiếm toàn văn bản với mã liên kết và tiêu đề liên kết |
size |
[Number, Không bắt buộc]. Số lượng kết quả mỗi trang, mặc định 20 kết quả. |
page |
[Number, Không bắt buộc]. Trang kết quả, mặc định là 0. Trang bắt đầu là 0. |
Ví dụ
Để xem chuỗi JSON đẹp hơn, chúng ta có thể sử dụng công cụ định dạng: https://format.asia/json-format
HTTP Status
200 |
Thành công |
401 |
Không có quyền truy cập |
403 |
Tài khoản của bạn bị khóa hoặc quyền bị từ chối |
429 |
Đăng nhập quá nhiều lần không thành công |
500 |
Một lỗi không xác định |
Chuỗi json được trả về, chứa các thông tin sau
status => code: 0 |
Thành công |
status => code: not equal 0 |
Lỗi |
status => message |
Thông báo lỗi |
status => timestamp |
Thời gian phản hồi của máy chủ |
Tạo liên kết
Chúng ta sử dụng API này để làm ngắn liên kết
Headers bắt buộc
Content-Type |
[String, Bắt buộc]. Giá trị là: application/json |
Authorization |
[String, Bắt buộc]]. Giá trị là: Bearer [access_token] |
Các tham số
teamId |
[String, Bắt buộc]. Lấy teamId từ API Lấy danh sách nhóm. |
domainId |
[String, Bắt buộc]. Lấy domainId từ API Lấy các tên miền được đăng ký. |
campaignId |
[String, Không bắt buộc]. Lấy campaignId từ API Lấy danh sách chiến dịch. |
noTitle |
[Boolean, Không bắt buộc]. Giá trị là: true hoặc false. Nếu giá trị là true, nó sẽ vô hiệu hóa việc lấy tiêu đề trang từ thẻ meta của trang nguồn, dẫn đến thời gian phản hồi API nhanh hơn (Kiểm tra gói đăng ký) |
destination |
[String, Bắt buộc]. Liên kết dài của bạn để rút ngắn |
utmSource |
[String, Không bắt buộc]. Nguồn chiến dịch |
utmMedium |
[String, Không bắt buộc]. Phương tiện chiến dịch |
utmCampaign |
[String, Không bắt buộc]. Tên chiến dịch |
utmTerm |
[String, Không bắt buộc]. Điều khoản chiến dịch |
utmContent |
[String, Không bắt buộc]. Nội dung chiến dịch |
Ví dụ
Để xem chuỗi JSON đẹp hơn, chúng ta có thể sử dụng công cụ định dạng: https://format.asia/json-format
HTTP Status
200 |
Thành công |
401 |
Không có quyền truy cập |
403 |
Tài khoản của bạn bị khóa hoặc quyền bị từ chối |
429 |
Đăng nhập quá nhiều lần không thành công |
500 |
Một lỗi không xác định |
Chuỗi json được trả về, chứa các thông tin sau
status => code: 0 |
Thành công |
status => code: not equal 0 |
Lỗi |
status => message |
Thông báo lỗi |
status => timestamp |
Thời gian phản hồi của máy chủ |
Cập nhật liên kết
Chúng ta sử dụng API này để cập nhật liên kết
Headers bắt buộc
Content-Type |
[String, Bắt buộc]. Giá trị là: application/json |
Authorization |
[String, Bắt buộc]]. Giá trị là: Bearer [access_token] |
Các tham số
linkId |
[String, Bắt buộc]. Lấy linkId từ API Lấy danh sách liên kết hoặc API Tạo liên kết |
title |
[String, Không bắt buộc]. Thay đổi tiêu đề. |
code |
[String, Không bắt buộc]. Thay đổi code (Back-half của liên kết). |
tags |
[Boolean, Không bắt buộc]. Gắn nhãn cho liên kết |
hide |
[String, Không bắt buộc]. Giá trị là "on" hoặc "off". Nếu "on" nó sẽ bị ẩn khỏi bảng điều khiển |
Ví dụ
Để xem chuỗi JSON đẹp hơn, chúng ta có thể sử dụng công cụ định dạng: https://format.asia/json-format
HTTP Status
200 |
Thành công |
401 |
Không có quyền truy cập |
403 |
Tài khoản của bạn bị khóa hoặc quyền bị từ chối |
429 |
Đăng nhập quá nhiều lần không thành công |
500 |
Một lỗi không xác định |
Chuỗi json được trả về, chứa các thông tin sau
status => code: 0 |
Thành công |
status => code: not equal 0 |
Lỗi |
status => message |
Thông báo lỗi |
status => timestamp |
Thời gian phản hồi của máy chủ |
Xóa liên kết
Chúng ta sử dụng API này để xóa liên kết
Headers bắt buộc
Content-Type |
[String, Bắt buộc]. Giá trị là: application/json |
Authorization |
[String, Bắt buộc]]. Giá trị là: Bearer [access_token] |
Các tham số
linkId |
[String, Bắt buộc]. Lấy linkId từ API Lấy danh sách liên kết hoặc API Tạo liên kết |
Ví dụ
Để xem chuỗi JSON đẹp hơn, chúng ta có thể sử dụng công cụ định dạng: https://format.asia/json-format
HTTP Status
200 |
Thành công |
401 |
Không có quyền truy cập |
403 |
Tài khoản của bạn bị khóa hoặc quyền bị từ chối |
429 |
Đăng nhập quá nhiều lần không thành công |
500 |
Một lỗi không xác định |
Chuỗi json được trả về, chứa các thông tin sau
status => code: 0 |
Thành công |
status => code: not equal 0 |
Lỗi |
status => message |
Thông báo lỗi |
status => timestamp |
Thời gian phản hồi của máy chủ |
Chuyển hướng liên kết
Chúng ta sử dụng API này để chuyển hướng liên kết, thay đổi loại nhấp chuột và thay đổi chiến dịch UTM
Headers bắt buộc
Content-Type |
[String, Bắt buộc]. Giá trị là: application/json |
Authorization |
[String, Bắt buộc]]. Giá trị là: Bearer [access_token] |
Các tham số
linkId |
[String, Bắt buộc]. Lấy linkId từ API Lấy danh sách liên kết hoặc API Tạo liên kết |
destination |
[String, Không bắt buộc]. Liên kết dài mới để chuyển hướng |
clickType |
[Number, Không bắt buộc]. Nếu giá trị là "0", nó sẽ được tính bằng tất cả các lần nhấp chuột. Nếu giá trị là "1" thì nó sẽ được tính bằng số lần nhấp chuột duy nhất. |
uniqueTime |
[Number, Không bắt buộc]. nếu clickType ở trên là "1", điều này sẽ xử lý cách thức hoạt động của Số lần nhấp duy nhất. Giả sử uniqueTime = 15 (phút), nếu người dùng click vào link liên tục ta chỉ tính cứ 15 phút là 1 click |
utmSource |
[String, Không bắt buộc]. Nguồn chiến dịch |
utmMedium |
[String, Không bắt buộc]. Phương tiện chiến dịch |
utmCampaign |
[String, Không bắt buộc]. Tên chiến dịch |
utmTerm |
[String, Không bắt buộc]. Điều khoản chiến dịch |
utmContent |
[String, Không bắt buộc]. Nội dung chiến dịch |
Ví dụ
Để xem chuỗi JSON đẹp hơn, chúng ta có thể sử dụng công cụ định dạng: https://format.asia/json-format
HTTP Status
200 |
Thành công |
401 |
Không có quyền truy cập |
403 |
Tài khoản của bạn bị khóa hoặc quyền bị từ chối |
429 |
Đăng nhập quá nhiều lần không thành công |
500 |
Một lỗi không xác định |
Chuỗi json được trả về, chứa các thông tin sau
status => code: 0 |
Thành công |
status => code: not equal 0 |
Lỗi |
status => message |
Thông báo lỗi |
status => timestamp |
Thời gian phản hồi của máy chủ |
Chuyển hướng liên kết điện thoại
API này sẽ chuyển hướng các liên kết khác nhau dựa trên nền tảng điện thoại mà người dùng sử dụng
Headers bắt buộc
Content-Type |
[String, Bắt buộc]. Giá trị là: application/json |
Authorization |
[String, Bắt buộc]]. Giá trị là: Bearer [access_token] |
Các tham số
linkId |
[String, Bắt buộc]. Lấy linkId từ API Lấy danh sách liên kết hoặc API Tạo liên kết |
ios |
[String, Không bắt buộc]. Nếu thiết bị của người dùng là nền tảng IOS, liên kết sẽ chuyển hướng đến đích này |
android |
[String, Không bắt buộc]. Nếu thiết bị của người dùng là nền tảng Android, liên kết sẽ chuyển hướng đến đích này |
windows |
[String, Không bắt buộc]. Nếu thiết bị của người dùng là nền tảng windows phone, liên kết sẽ chuyển hướng đến đích này |
mobile |
[String, Không bắt buộc]. Nếu thiết bị của người dùng là di động và không phải là một trong các nền tảng trên, liên kết sẽ chuyển hướng đến đích này |
Ví dụ
Để xem chuỗi JSON đẹp hơn, chúng ta có thể sử dụng công cụ định dạng: https://format.asia/json-format
HTTP Status
200 |
Thành công |
401 |
Không có quyền truy cập |
403 |
Tài khoản của bạn bị khóa hoặc quyền bị từ chối |
429 |
Đăng nhập quá nhiều lần không thành công |
500 |
Một lỗi không xác định |
Chuỗi json được trả về, chứa các thông tin sau
status => code: 0 |
Thành công |
status => code: not equal 0 |
Lỗi |
status => message |
Thông báo lỗi |
status => timestamp |
Thời gian phản hồi của máy chủ |
Liên kết hết hạn
API này sẽ đặt hết hạn của liên kết theo thời gian hoặc số lần nhấp chuột
Headers bắt buộc
Content-Type |
[String, Bắt buộc]. Giá trị là: application/json |
Authorization |
[String, Bắt buộc]]. Giá trị là: Bearer [access_token] |
Các tham số
linkId |
[String, Bắt buộc]. Lấy linkId từ API Lấy danh sách liên kết hoặc API Tạo liên kết |
date |
[String, Không bắt buộc]. Ngày hết hạn, định dạng: dd/MM/yyyy |
destinationByDate |
[String, Không bắt buộc]. Liên kết sẽ chuyển hướng đến đích này sau ngày date |
click |
[Number, Không bắt buộc]. Số lần nhấp chuột sẽ hết hạn |
clickType |
[Number, Không bắt buộc]. Nếu giá trị là "0", click ở trên sẽ tính tất cả các lần nhấp chuột. Nếu giá trị là "1" click ở trên sẽ chỉ tính số nhấp chuột duy nhất. |
destinationByClick |
[String, Không bắt buộc]. Nếu số lượng nhấp chuột nhiều hơn click ở trên, liên kết sẽ chuyển hướng đến đích này |
Ví dụ
Để xem chuỗi JSON đẹp hơn, chúng ta có thể sử dụng công cụ định dạng: https://format.asia/json-format
HTTP Status
200 |
Thành công |
401 |
Không có quyền truy cập |
403 |
Tài khoản của bạn bị khóa hoặc quyền bị từ chối |
429 |
Đăng nhập quá nhiều lần không thành công |
500 |
Một lỗi không xác định |
Chuỗi json được trả về, chứa các thông tin sau
status => code: 0 |
Thành công |
status => code: not equal 0 |
Lỗi |
status => message |
Thông báo lỗi |
status => timestamp |
Thời gian phản hồi của máy chủ |
Mật khẩu liên kết
API này sẽ đặt mật khẩu cho liên kết. Người dùng phải điền mật khẩu trước khi đến đích
Headers bắt buộc
Content-Type |
[String, Bắt buộc]. Giá trị là: application/json |
Authorization |
[String, Bắt buộc]]. Giá trị là: Bearer [access_token] |
Các tham số
linkId |
[String, Bắt buộc]. Lấy linkId từ API Lấy danh sách liên kết hoặc API Tạo liên kết |
password |
[String, Bắt buộc]. Mật khẩu để mở liên kết |
Ví dụ
Để xem chuỗi JSON đẹp hơn, chúng ta có thể sử dụng công cụ định dạng: https://format.asia/json-format
HTTP Status
200 |
Thành công |
401 |
Không có quyền truy cập |
403 |
Tài khoản của bạn bị khóa hoặc quyền bị từ chối |
429 |
Đăng nhập quá nhiều lần không thành công |
500 |
Một lỗi không xác định |
Chuỗi json được trả về, chứa các thông tin sau
status => code: 0 |
Thành công |
status => code: not equal 0 |
Lỗi |
status => message |
Thông báo lỗi |
status => timestamp |
Thời gian phản hồi của máy chủ |
Lấy danh sách công cụ theo dõi
API này sẽ lấy về danh sách theo dõi. Nhúng trình theo dõi nhắm mục tiêu lại sẽ giúp bạn theo dõi tất cả các lượt truy cập của mình vào các công cụ khác để phân tích. Bao gồm Facebook Pixel, Google Analytics Pixel, Quora Pixel, Twitter Pixel, Google Tag Manager Pixel, Linkedin Pixel, Google Adwords Pixel, Pinterest Pixel, Segment Pixel...
Headers bắt buộc
Content-Type |
[String, Bắt buộc]. Giá trị là: application/json |
Authorization |
[String, Bắt buộc]]. Giá trị là: Bearer [access_token] |
Các tham số
Ví dụ
Để xem chuỗi JSON đẹp hơn, chúng ta có thể sử dụng công cụ định dạng: https://format.asia/json-format
HTTP Status
200 |
Thành công |
401 |
Không có quyền truy cập |
403 |
Tài khoản của bạn bị khóa hoặc quyền bị từ chối |
429 |
Đăng nhập quá nhiều lần không thành công |
500 |
Một lỗi không xác định |
Chuỗi json được trả về, chứa các thông tin sau
status => code: 0 |
Thành công |
status => code: not equal 0 |
Lỗi |
status => message |
Thông báo lỗi |
status => timestamp |
Thời gian phản hồi của máy chủ |
Lấy danh sách công cụ theo dõi của nhóm
API này sẽ lầy về danh sách công cụ theo dõi của nhóm. Chúng ta có thể tạo công cụ theo dõi của nhóm từ bảng điều khiển.
Headers bắt buộc
Content-Type |
[String, Bắt buộc]. Giá trị là: application/json |
Authorization |
[String, Bắt buộc]]. Giá trị là: Bearer [access_token] |
Các tham số
teamId |
[String, Bắt buộc]. Lấy teamId từ API Lấy danh sách nhóm. |
size |
[Number, Không bắt buộc]. Số lượng kết quả mỗi trang, mặc định 20 kết quả. |
page |
[Number, Không bắt buộc]. Trang kết quả, mặc định là 0. Trang bắt đầu là 0. |
Ví dụ
Để xem chuỗi JSON đẹp hơn, chúng ta có thể sử dụng công cụ định dạng: https://format.asia/json-format
HTTP Status
200 |
Thành công |
401 |
Không có quyền truy cập |
403 |
Tài khoản của bạn bị khóa hoặc quyền bị từ chối |
429 |
Đăng nhập quá nhiều lần không thành công |
500 |
Một lỗi không xác định |
Chuỗi json được trả về, chứa các thông tin sau
status => code: 0 |
Thành công |
status => code: not equal 0 |
Lỗi |
status => message |
Thông báo lỗi |
status => timestamp |
Thời gian phản hồi của máy chủ |
Lấy danh sách công cụ theo dõi của liên kết
API này sẽ lấy về danh sách công cụ theo dõi của liên kết.
Headers bắt buộc
Content-Type |
[String, Bắt buộc]. Giá trị là: application/json |
Authorization |
[String, Bắt buộc]]. Giá trị là: Bearer [access_token] |
Các tham số
linkId |
[String, Bắt buộc]. Lấy linkId từ API Lấy danh sách liên kết hoặc API Tạo liên kết |
size |
[Number, Không bắt buộc]. Số lượng kết quả mỗi trang, mặc định 20 kết quả. |
page |
[Number, Không bắt buộc]. Trang kết quả, mặc định là 0. Trang bắt đầu là 0. |
Ví dụ
Để xem chuỗi JSON đẹp hơn, chúng ta có thể sử dụng công cụ định dạng: https://format.asia/json-format
HTTP Status
200 |
Thành công |
401 |
Không có quyền truy cập |
403 |
Tài khoản của bạn bị khóa hoặc quyền bị từ chối |
429 |
Đăng nhập quá nhiều lần không thành công |
500 |
Một lỗi không xác định |
Chuỗi json được trả về, chứa các thông tin sau
status => code: 0 |
Thành công |
status => code: not equal 0 |
Lỗi |
status => message |
Thông báo lỗi |
status => timestamp |
Thời gian phản hồi của máy chủ |
Tạo công cụ theo dõi của liên kết
API này sẽ tạo công cụ theo dõi của liên kết.
Headers bắt buộc
Content-Type |
[String, Bắt buộc]. Giá trị là: application/json |
Authorization |
[String, Bắt buộc]]. Giá trị là: Bearer [access_token] |
Các tham số
linkId |
[String, Bắt buộc]. Lấy linkId từ API Lấy danh sách liên kết hoặc API Tạo liên kết |
type |
[String, Bắt buộc]. Nếu giá trị là "1", chúng ta sẽ tạo công cụ theo dõi của liên kết bằng cách sao chép công cụ theo dõi của nhóm. Nếu giá trị là "0", chúng ta sẽ tạo công cụ theo dõi của liên kết bằng cách thêm trực tiếp mã mới của nhà cung cấp công cụ theo dõi (như mã Google pixel...) |
teamTrackers |
[String array, Không bắt buộc]. Bắt buộc nếu type bên trên là "1".
Nếu giá trị là "all-trackers", chúng ta sẽ tạo công cụ theo dõi của liên kết bằng cách sao chép toàn bộ công cụ theo dõi của nhóm. Nếu không nó sẽ là danh sách teamTrackers => id được lấy từ API: Lấy danh sách công cụ theo dõi của nhóm |
code |
[String, Không bắt buộc]. Bắt buộc nếu type bên trên là "0". Mã code của nhà cung cấp công cụ theo dõi (Như mã Google pixel...) |
trackerId |
[String, Không bắt buộc]. Bắt buộc nếu type bên trên làs "0". Lấy trackerId từ trackers => id tại API: Lấy danh sách công cụ theo dõi |
Ví dụ
Để xem chuỗi JSON đẹp hơn, chúng ta có thể sử dụng công cụ định dạng: https://format.asia/json-format
HTTP Status
200 |
Thành công |
401 |
Không có quyền truy cập |
403 |
Tài khoản của bạn bị khóa hoặc quyền bị từ chối |
429 |
Đăng nhập quá nhiều lần không thành công |
500 |
Một lỗi không xác định |
Chuỗi json được trả về, chứa các thông tin sau
status => code: 0 |
Thành công |
status => code: not equal 0 |
Lỗi |
status => message |
Thông báo lỗi |
status => timestamp |
Thời gian phản hồi của máy chủ |
Xóa công cụ theo dõi của liên kết
API này sẽ xóa công cụ theo dõi của liên kết
Headers bắt buộc
Content-Type |
[String, Bắt buộc]. Giá trị là: application/json |
Authorization |
[String, Bắt buộc]]. Giá trị là: Bearer [access_token] |
Các tham số
linkTrackerId |
[String, Bắt buộc]. Lấy linkTrackerId từ API: Lấy danh sách công cụ theo dõi của liên kết . |
Ví dụ
Để xem chuỗi JSON đẹp hơn, chúng ta có thể sử dụng công cụ định dạng: https://format.asia/json-format
HTTP Status
200 |
Thành công |
401 |
Không có quyền truy cập |
403 |
Tài khoản của bạn bị khóa hoặc quyền bị từ chối |
429 |
Đăng nhập quá nhiều lần không thành công |
500 |
Một lỗi không xác định |
Chuỗi json được trả về, chứa các thông tin sau
status => code: 0 |
Thành công |
status => code: not equal 0 |
Lỗi |
status => message |
Thông báo lỗi |
status => timestamp |
Thời gian phản hồi của máy chủ |
Thử nghiệm liên kết A/B/C/D/E/F...
API này sẽ đặt các URL chuyển hướng thay thế để xem URL nào là tốt nhất cho khách hàng
Headers bắt buộc
Content-Type |
[String, Bắt buộc]. Giá trị là: application/json |
Authorization |
[String, Bắt buộc]]. Giá trị là: Bearer [access_token] |
Các tham số
linkId |
[String, Bắt buộc]. Lấy linkId từ API Lấy danh sách liên kết hoặc API Tạo liên kết |
testing |
[Object Array, Bắt buộc]. Mảng các đối tượng chứa: link và percentage .
link (String) là liên kết đích và percentage (Number: 1-100 phần trăm) là tỷ lệ để chuyển hướng.
Theo thứ tự mỗi một đối tượng trong mảng tương ứng với các thử nghiệm A,B,C,D...
|
Ví dụ
Để xem chuỗi JSON đẹp hơn, chúng ta có thể sử dụng công cụ định dạng: https://format.asia/json-format
HTTP Status
200 |
Thành công |
401 |
Không có quyền truy cập |
403 |
Tài khoản của bạn bị khóa hoặc quyền bị từ chối |
429 |
Đăng nhập quá nhiều lần không thành công |
500 |
Một lỗi không xác định |
Chuỗi json được trả về, chứa các thông tin sau
status => code: 0 |
Thành công |
status => code: not equal 0 |
Lỗi |
status => message |
Thông báo lỗi |
status => timestamp |
Thời gian phản hồi của máy chủ |
Phân tích liên kết
API này sẽ lấy về các phân tích của liên kết theo bộ lọc thời gian
Headers bắt buộc
Content-Type |
[String, Bắt buộc]. Giá trị là: application/json |
Authorization |
[String, Bắt buộc]]. Giá trị là: Bearer [access_token] |
Các tham số
linkId |
[String, Bắt buộc]. Lấy linkId từ API Lấy danh sách liên kết hoặc API Tạo liên kết |
startTime |
[String, Không bắt buộc]. Thời gian bắt đầu để lọc, định dạng: dd/MM/yyyy. Nếu không được chỉ định, nó sẽ lọc trong 30 ngày qua |
endTime |
[String, Không bắt buộc]. Thời gian kết thúc để lọc, định dạng: dd/MM/yyyy. Nếu không được chỉ định, nó sẽ lọc trong 30 ngày qua |
Ví dụ
Để xem chuỗi JSON đẹp hơn, chúng ta có thể sử dụng công cụ định dạng: https://format.asia/json-format
HTTP Status
200 |
Thành công |
401 |
Không có quyền truy cập |
403 |
Tài khoản của bạn bị khóa hoặc quyền bị từ chối |
429 |
Đăng nhập quá nhiều lần không thành công |
500 |
Một lỗi không xác định |
Chuỗi json được trả về, chứa các thông tin sau
status => code: 0 |
Thành công |
status => code: not equal 0 |
Lỗi |
status => message |
Thông báo lỗi |
status => timestamp |
Thời gian phản hồi của máy chủ |
Nếu HTTP Status là 200 và status => code
bằng 0, thì
metricsMap => 1 |
Nguồn nhấp chuột theo ngày |
metricsMap => 2 |
Thiết bị nhấp chuột |
metricsMap => 3 |
Hệ điều hành (OS) nhấp chuột |
metricsMap => 4 |
Trình duyệt nhấp chuột |
metricsMap => 5 |
Thương hiệu nhấp chuột |
metricsMap => 6 |
Ngôn ngữ nhấp chuột |
metricsMap => 7 |
Vị trí địa lý nhấp chuột |
metricsMap => 8 |
Nhấp tự động (bot). Không có sẵn trên gói miễn phí |
metricsMap => 9 |
Tất cả nhấp chuột theo ngày |
Giới hạn API
Giới hạn API theo tài khoản phụ thuộc vào gói đăng ký
Xem giới hạn API |