API document

SHORTEN WORLD's API exposes the entire SHORTEN WORLD infrastructure via a standardized programmatic interface. Using SHORTEN WORLD's API, you can do just about anything you can do on shortenworld.com via the customer dashboard.

The SHORTEN WORLD API is a RESTful API based on HTTPS requests and JSON responses. If you are registered with SHORTEN WORLD, you can obtain your API key from the top of the "API key" page, found here: Go to My account

Endpoints

The API is accessed by making HTTPS requests to a specific version endpoint URL, in which GET, POST, PUT, PATCH, and DELETE methods dictate how your interact with the information available. Every endpoint is accessed only via the SSL-enabled HTTPS (port 443) protocol.

Everything (methods, parameters, etc.) is fixed to a version number, and every call must contain one. The latest version is Version 1.

The stable base URL for all Version 1 HTTPS endpoints is:

                    
								https://api.shortenworld.com/v1/

All API list

Get token
Refresh token
Revoke token
Get team list
Get campaign list
Get domain subscriptions
Get link list
Create link
Update link
Delete link
Redirect link
Redirect mobile link
Expiration link
Link password
Get tracker list
Get team tracker list
Get link tracker list
Create link tracker
Delete link tracker
Link A/B/C/D/E/F... testing
Link analytics
API limits

Get token

First of all, we need to use this API to authen yourself and get the token. We will use this token to authenticate all other APIs. Using access_token to authen other APIs, and using refresh_token to get a new access_token without calling this API again

Required headers

Content-Type [String, Required]. Value is: application/json

Possible parameters

`username`	[String, Required]. Your username (not email).
`key`	[String, Required]. Your API key.

Examples

cURL Response

                    
									
curl -X POST https://api.shortenworld.com/v1/authen/token \
	 -H "Content-Type: application/json" \
	 -d '{"username":"shortenworld","key":"vis5ok7k108prtieq7xeyvx4ay1me4oz"}'

                    
									
{
  "status": {
    "message": "Wow, successfully!",
    "code": 0,
    "timestamp": "2022-12-21T05:24:14+0000"
  },
  "token": {
    "scope": "read write",
    "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzaG9ydGVud29ybGQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiZXhwIjoxNjcxNzk5NjE0LCJ1c2VyIjp7ImlkIjoxMDEwLCJjaWYiOiJlYWUyZDc5NS0wYzZmLTQ2MWItYTZkNC1lYjRmYTUwOGI4YzkiLCJ1c2VybmFtZSI6InNob3J0ZW53b3JsZCIsImVtYWlsIjoic3VwcG9ydEBzaG9ydGVud29ybGQuY29tIiwiZnVsbE5hbWUiOiJI4buTbmcgTmh1bmciLCJsZXZlbCI6MCwibWFuYWdlciI6ZmFsc2UsImJhbmsiOmZhbHNlLCJ0b3RhbExvZ2luIjoxLCJ0b2RheUxvZ2luIjoxLCJsYXN0TG9naW5UaW1lIjpudWxsLCJsYXN0TG9naW5JcCI6bnVsbCwibGFzdExvZ2luRGV2aWNlIjpudWxsLCJsYXN0TG9naW5Mb2NhdGlvbiI6bnVsbCwibG9jYWxlIjoidmkifSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9VU0VSIl0sImp0aSI6IjcxSTFmcXViSjhPM3o2WEFZOUQ1UXg4bURJYz0iLCJjbGllbnRfaWQiOiJhcGlMaW5rIn0.U2BFp7ryXMWn5qiKEKrj-5ieL0LKX7HHnIKoZivMmEVo5LJq8TOkHgXM4P1IPc-X285B2266lgSSm6R4WrdOX06hXfa8o3TXpGdwGqMyJFWuW1SGU7StkuRif_baQLQ4SwsQKgdfUG31KZe1EjhO0FX5fnTbgbst7XcYo4dXGnlPQD8yItRSfVtSEkmkUjw028CQZcjFTQ5cNtTSvkMmQU4xVjO3Dl_3_hmI3Mq2aSdyhH_FI6z8Bez5FC0-JbVIvuPalM4u5vKoikwvtSgt2jiWv1XRmeDSM5SSvU_-1vaMEAGhaxrIvOhoJ0OCyUjM_9hwxl5huBywYB5MDuYYgg",
    "token_type": "bearer",
    "refresh_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzaG9ydGVud29ybGQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiYXRpIjoiNzFJMWZxdWJKOE8zejZYQVk5RDVReDhtREljPSIsImV4cCI6MTY3MjMzOTYxNCwidXNlciI6eyJpZCI6MTAxMCwiY2lmIjoiZWFlMmQ3OTUtMGM2Zi00NjFiLWE2ZDQtZWI0ZmE1MDhiOGM5IiwidXNlcm5hbWUiOiJzaG9ydGVud29ybGQiLCJlbWFpbCI6InN1cHBvcnRAc2hvcnRlbndvcmxkLmNvbSIsImZ1bGxOYW1lIjoiSOG7k25nIE5odW5nIiwibGV2ZWwiOjAsIm1hbmFnZXIiOmZhbHNlLCJiYW5rIjpmYWxzZSwidG90YWxMb2dpbiI6MSwidG9kYXlMb2dpbiI6MSwibGFzdExvZ2luVGltZSI6bnVsbCwibGFzdExvZ2luSXAiOm51bGwsImxhc3RMb2dpbkRldmljZSI6bnVsbCwibGFzdExvZ2luTG9jYXRpb24iOm51bGwsImxvY2FsZSI6InZpIn0sImF1dGhvcml0aWVzIjpbIlJPTEVfVVNFUiJdLCJqdGkiOiI0QUtvVnV1TU9yRnpuUHpRNkhCNkVGcE9XT2M9IiwiY2xpZW50X2lkIjoiYXBpTGluayJ9.NXHc2aesqnyA_DdoyhK-tJffIVv4oF80aOZFmm3eOV-V4SolHumZRIjHW7lSs6baIOjZj4XLCpXjJP7G2Pslm6H_ZhfK4ihSudbGJ_KHjX5ZRKh-q1yTt8m3UVG0Lzj30gBYeISuaEdqDh6MMZZXrz3LJCTWAXOgYr2TGQK85W-TnP3KzeRO4R9MQVyqgu8YJP1z2ijdaJSMEfggDPVQvPCm8KNVNHTq3l3pvkxOZHQ04Di3-EfPdrlljf99AFSNdgsUPf2iB9va3Ffm1MVzg6TDOdWh_rj_c1oDrNbPUP7KTbzdGz4oulcAoMVFhOLR0p0IH82zODLXj4dM8Ac6bA",
    "expires_in": 104084
  }
}

To get pretty JSON response we can use format tool: https://format.asia/json-format

HTTP Status

`200`	Success
`401`	Unauthorized
`403`	Your account is locked or permission denied
`429`	Login too many failed
`500`	An unknown error

Json string will be sent, containing following data

`status => code: 0`	Success
`status => code: not equal 0`	Error
`status => message`	Error message
`status => timestamp`	The time server responses

If HTTP Status is 200 and `status => code` is equal to 0, then

`token => access_token`	Using this `access_token` to authen other APIs. It will be valid in 01 hour
`token => refresh_token`	Using `refresh_token` to get a new `access_token` without calling this API again. It will be valid in 07 days
`token => expires_in`	The rest time (in second) access_token is valid

Refresh token

We use this API to refresh a new token base on the old refresh_token.

Required headers

Content-Type [String, Required]. Value is: application/json

Possible parameters

refreshToken [String, Required]. Get refresh_token from the response of Get token API.

Examples

cURL Response

                    
									
curl -X POST https://api.shortenworld.com/v1/authen/refresh-token \
	 -H "Content-Type: application/json" \
	 -d '{"refreshToken":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzaG9ydGVud29ybGQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiYXRpIjoiNzFJMWZxdWJKOE8zejZYQVk5RDVReDhtREljPSIsImV4cCI6MTY3MjMzOTYxNCwidXNlciI6eyJpZCI6MTAxMCwiY2lmIjoiZWFlMmQ3OTUtMGM2Zi00NjFiLWE2ZDQtZWI0ZmE1MDhiOGM5IiwidXNlcm5hbWUiOiJzaG9ydGVud29ybGQiLCJlbWFpbCI6InN1cHBvcnRAc2hvcnRlbndvcmxkLmNvbSIsImZ1bGxOYW1lIjoiSOG7k25nIE5odW5nIiwibGV2ZWwiOjAsIm1hbmFnZXIiOmZhbHNlLCJiYW5rIjpmYWxzZSwidG90YWxMb2dpbiI6MSwidG9kYXlMb2dpbiI6MSwibGFzdExvZ2luVGltZSI6bnVsbCwibGFzdExvZ2luSXAiOm51bGwsImxhc3RMb2dpbkRldmljZSI6bnVsbCwibGFzdExvZ2luTG9jYXRpb24iOm51bGwsImxvY2FsZSI6InZpIn0sImF1dGhvcml0aWVzIjpbIlJPTEVfVVNFUiJdLCJqdGkiOiI0QUtvVnV1TU9yRnpuUHpRNkhCNkVGcE9XT2M9IiwiY2xpZW50X2lkIjoiYXBpTGluayJ9.NXHc2aesqnyA_DdoyhK-tJffIVv4oF80aOZFmm3eOV-V4SolHumZRIjHW7lSs6baIOjZj4XLCpXjJP7G2Pslm6H_ZhfK4ihSudbGJ_KHjX5ZRKh-q1yTt8m3UVG0Lzj30gBYeISuaEdqDh6MMZZXrz3LJCTWAXOgYr2TGQK85W-TnP3KzeRO4R9MQVyqgu8YJP1z2ijdaJSMEfggDPVQvPCm8KNVNHTq3l3pvkxOZHQ04Di3-EfPdrlljf99AFSNdgsUPf2iB9va3Ffm1MVzg6TDOdWh_rj_c1oDrNbPUP7KTbzdGz4oulcAoMVFhOLR0p0IH82zODLXj4dM8Ac6bA"}'

                    
									
{
  "status": {
    "message": "Wow, successfully!",
    "code": 0,
    "timestamp": "2022-12-21T11:33:07+0000"
  },
  "token": {
    "scope": "read write",
    "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzaG9ydGVud29ybGQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiZXhwIjoxNjcxNjI1OTg3LCJ1c2VyIjp7ImlkIjoxMDEwLCJjaWYiOiJlYWUyZDc5NS0wYzZmLTQ2MWItYTZkNC1lYjRmYTUwOGI4YzkiLCJ1c2VybmFtZSI6InNob3J0ZW53b3JsZCIsImVtYWlsIjoic3VwcG9ydEBzaG9ydGVud29ybGQuY29tIiwiZnVsbE5hbWUiOiJI4buTbmcgTmh1bmciLCJsZXZlbCI6MCwibWFuYWdlciI6ZmFsc2UsImJhbmsiOmZhbHNlLCJ0b3RhbExvZ2luIjoxLCJ0b2RheUxvZ2luIjoxLCJsYXN0TG9naW5UaW1lIjpudWxsLCJsYXN0TG9naW5JcCI6bnVsbCwibGFzdExvZ2luRGV2aWNlIjpudWxsLCJsYXN0TG9naW5Mb2NhdGlvbiI6bnVsbCwibG9jYWxlIjoidmkifSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9VU0VSIl0sImp0aSI6IlB0R3ROd2hwcVMrSElLYnFoNEFhdlFkU1RPMD0iLCJjbGllbnRfaWQiOiJhcGlMaW5rIn0.B400MYwEdL5j9U4E3HGZ0SqQ6n38NwQvp7o2n-GROZyUZmEDPRQYDDa6v9AqVqbCdPuKbrWQv2QeU_PGHD5lcsx5RDvkHAPxhz8WNcAeYjgBC9uVYOQ8giMYotJ13b14jpUba5bdnoFB-ozvkqnnfZWStacYEDhbhbu8Udd2xtHp4CDwMEJDsV0UcOmCDw6MKAc4NFmKCXThXTi6FhxUlYS2YJ4WjXX94Gjiw5nnRRgeNSJQEAjkotTV3RPoi6VzQFL4hyp2zdzJxWtAKqTGEv2njBJG7CPN_4e71EJ5w6ovZ1OxTkHUBfugaQjoS4reZzJiBdUE2ONFfrfXT1Zc6A",
    "token_type": "bearer",
    "refresh_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzaG9ydGVud29ybGQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiYXRpIjoiUHRHdE53aHBxUytISUticWg0QWF2UWRTVE8wPSIsImV4cCI6MTY3MTcwODc4NywidXNlciI6eyJpZCI6MTAxMCwiY2lmIjoiZWFlMmQ3OTUtMGM2Zi00NjFiLWE2ZDQtZWI0ZmE1MDhiOGM5IiwidXNlcm5hbWUiOiJzaG9ydGVud29ybGQiLCJlbWFpbCI6InN1cHBvcnRAc2hvcnRlbndvcmxkLmNvbSIsImZ1bGxOYW1lIjoiSOG7k25nIE5odW5nIiwibGV2ZWwiOjAsIm1hbmFnZXIiOmZhbHNlLCJiYW5rIjpmYWxzZSwidG90YWxMb2dpbiI6MSwidG9kYXlMb2dpbiI6MSwibGFzdExvZ2luVGltZSI6bnVsbCwibGFzdExvZ2luSXAiOm51bGwsImxhc3RMb2dpbkRldmljZSI6bnVsbCwibGFzdExvZ2luTG9jYXRpb24iOm51bGwsImxvY2FsZSI6InZpIn0sImF1dGhvcml0aWVzIjpbIlJPTEVfVVNFUiJdLCJqdGkiOiI2NkRHWW5OVHd6TWl2SGt6ZkJrQk84Q2pmaWM9IiwiY2xpZW50X2lkIjoiYXBpTGluayJ9.ktVy8xq4-tlOK2Lq36ZxrCPkETVp0jHesdOysiev3jelBetj0PrVod2Gpk94GQWYsNux1XTQ58BcuvBwBHUJAlxNniCYHEKzpavuAuxF074v-WjBOt0B_viq4EwMszZSbOIRKymtR8sL925IIrl2lSeXV7rM01W-TGbz7fv07l_0xaqGF-3x1hZpXYnW3d82bWVvbA9zA-Gb0nHcKyTjXn9iHAHJlc9qDBnzDyyZVyh5P4qqu4TP-7FgNqcQQPWvyr_vM5B6OIU8ZYDzW8vf5zpwdH9Fq-pIUY8V2rrpxd3jmUd3ig2gMREDcox2ZNhYZDzjvglMnBwaLPKPGG-x7A",
    "expires_in": 3599
  }
}

To get pretty JSON response we can use format tool: https://format.asia/json-format

HTTP Status

`200`	Success
`401`	Unauthorized
`403`	Your account is locked or permission denied
`429`	Login too many failed
`500`	An unknown error

Json string will be sent, containing following data

`status => code: 0`	Success
`status => code: not equal 0`	Error
`status => message`	Error message
`status => timestamp`	The time server responses

If HTTP Status is 200 and status=>code is equal to 0, then

`token => access_token`	Using this `access_token` to authen other APIs. It will be valid in 01 hour
`token => refresh_token`	Using `refresh_token` to get a new `access_token` without calling Get token API again. It will be valid in 07 days
`token => expires_in`	The rest time (in second) access_token is valid

Revoke token

We use this API to revoke a token.

Required headers

`Content-Type`	[String, Required]. Value is: application/json
`Authorization`	[String, Required]. Value is: Bearer [access_token]

Possible parameters

Examples

cURL Response

                    
									
curl -X POST https://api.shortenworld.com/v1/authen/revoke-token \
	 -H "Content-Type: application/json" \
	 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzaG9ydGVud29ybGQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiZXhwIjoxNjcxNjI1OTg3LCJ1c2VyIjp7ImlkIjoxMDEwLCJjaWYiOiJlYWUyZDc5NS0wYzZmLTQ2MWItYTZkNC1lYjRmYTUwOGI4YzkiLCJ1c2VybmFtZSI6InNob3J0ZW53b3JsZCIsImVtYWlsIjoic3VwcG9ydEBzaG9ydGVud29ybGQuY29tIiwiZnVsbE5hbWUiOiJI4buTbmcgTmh1bmciLCJsZXZlbCI6MCwibWFuYWdlciI6ZmFsc2UsImJhbmsiOmZhbHNlLCJ0b3RhbExvZ2luIjoxLCJ0b2RheUxvZ2luIjoxLCJsYXN0TG9naW5UaW1lIjpudWxsLCJsYXN0TG9naW5JcCI6bnVsbCwibGFzdExvZ2luRGV2aWNlIjpudWxsLCJsYXN0TG9naW5Mb2NhdGlvbiI6bnVsbCwibG9jYWxlIjoidmkifSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9VU0VSIl0sImp0aSI6IlB0R3ROd2hwcVMrSElLYnFoNEFhdlFkU1RPMD0iLCJjbGllbnRfaWQiOiJhcGlMaW5rIn0.B400MYwEdL5j9U4E3HGZ0SqQ6n38NwQvp7o2n-GROZyUZmEDPRQYDDa6v9AqVqbCdPuKbrWQv2QeU_PGHD5lcsx5RDvkHAPxhz8WNcAeYjgBC9uVYOQ8giMYotJ13b14jpUba5bdnoFB-ozvkqnnfZWStacYEDhbhbu8Udd2xtHp4CDwMEJDsV0UcOmCDw6MKAc4NFmKCXThXTi6FhxUlYS2YJ4WjXX94Gjiw5nnRRgeNSJQEAjkotTV3RPoi6VzQFL4hyp2zdzJxWtAKqTGEv2njBJG7CPN_4e71EJ5w6ovZ1OxTkHUBfugaQjoS4reZzJiBdUE2ONFfrfXT1Zc6A" \
	 -d '{}'

                    
									
{
  "status": {
    "message": "Wow, successfully!",
    "code": 0,
    "timestamp": "2022-12-21T11:50:53+0000"
  }
}

To get pretty JSON response we can use format tool: https://format.asia/json-format

HTTP Status

`200`	Success
`401`	Unauthorized
`403`	Your account is locked or permission denied
`429`	Login too many failed
`500`	An unknown error

Json string will be sent, containing following data

`status => code: 0`	Success
`status => code: not equal 0`	Error
`status => message`	Error message
`status => timestamp`	The time server responses

Get team list

We use this API to get all team list which belong to you or you are member

Required headers

`Content-Type`	[String, Required]. Value is: application/json
`Authorization`	[String, Required]. Value is: Bearer [access_token]

Possible parameters

`size`	[Number, Optional]. The number of results each page, default 20 results.
`page`	[Number, Optional]. The page of results, default is 0. Start page is 0.

Examples

cURL Response

                    
									
curl -X POST https://api.shortenworld.com/v1/entity/team/list \
	 -H "Content-Type: application/json" \
	 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzaG9ydGVud29ybGQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiZXhwIjoxNjcxNjI1OTg3LCJ1c2VyIjp7ImlkIjoxMDEwLCJjaWYiOiJlYWUyZDc5NS0wYzZmLTQ2MWItYTZkNC1lYjRmYTUwOGI4YzkiLCJ1c2VybmFtZSI6InNob3J0ZW53b3JsZCIsImVtYWlsIjoic3VwcG9ydEBzaG9ydGVud29ybGQuY29tIiwiZnVsbE5hbWUiOiJI4buTbmcgTmh1bmciLCJsZXZlbCI6MCwibWFuYWdlciI6ZmFsc2UsImJhbmsiOmZhbHNlLCJ0b3RhbExvZ2luIjoxLCJ0b2RheUxvZ2luIjoxLCJsYXN0TG9naW5UaW1lIjpudWxsLCJsYXN0TG9naW5JcCI6bnVsbCwibGFzdExvZ2luRGV2aWNlIjpudWxsLCJsYXN0TG9naW5Mb2NhdGlvbiI6bnVsbCwibG9jYWxlIjoidmkifSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9VU0VSIl0sImp0aSI6IlB0R3ROd2hwcVMrSElLYnFoNEFhdlFkU1RPMD0iLCJjbGllbnRfaWQiOiJhcGlMaW5rIn0.B400MYwEdL5j9U4E3HGZ0SqQ6n38NwQvp7o2n-GROZyUZmEDPRQYDDa6v9AqVqbCdPuKbrWQv2QeU_PGHD5lcsx5RDvkHAPxhz8WNcAeYjgBC9uVYOQ8giMYotJ13b14jpUba5bdnoFB-ozvkqnnfZWStacYEDhbhbu8Udd2xtHp4CDwMEJDsV0UcOmCDw6MKAc4NFmKCXThXTi6FhxUlYS2YJ4WjXX94Gjiw5nnRRgeNSJQEAjkotTV3RPoi6VzQFL4hyp2zdzJxWtAKqTGEv2njBJG7CPN_4e71EJ5w6ovZ1OxTkHUBfugaQjoS4reZzJiBdUE2ONFfrfXT1Zc6A" \
	 -d '{"size":20,"page":0}'

                    
									
{
  "status": {
    "message": "Wow, successfully!",
    "code": 0,
    "timestamp": "2022-12-22T02:33:23+0000"
  },
  "teams": [
    {
      "id": "6340e9c7a26da453b891b752",
      "code": "megachat",
      "name": "Megachat Team",
      "roles": "ROLE_OWNER, ROLE_MEMBER, ROLE_ADMIN",
      "members": 2,
      "links": 36,
      "joinedDate": "2022-10-08T03:08:55.129+0000"
    },
    {
      "id": "634fbd79b4a38d4a20a62002",
      "code": "meta",
      "name": "Meta Team",
      "roles": "ROLE_OWNER, ROLE_ADMIN",
      "members": 1,
      "links": 0,
      "joinedDate": "2022-10-19T09:03:53.091+0000"
    },
    {
      "id": "632ac6b64f71000068007b66",
      "code": "bigbang",
      "name": "Bigbang Shorten World Team",
      "roles": "ROLE_MEMBER",
      "members": 2,
      "links": 19,
      "joinedDate": "2022-12-19T04:15:32.895+0000"
    }
  ],
  "total": 3
}

To get pretty JSON response we can use format tool: https://format.asia/json-format

HTTP Status

`200`	Success
`401`	Unauthorized
`403`	Your account is locked or permission denied
`429`	Login too many failed
`500`	An unknown error

Json string will be sent, containing following data

`status => code: 0`	Success
`status => code: not equal 0`	Error
`status => message`	Error message
`status => timestamp`	The time server responses

Get campaign list

We use this API to get all campaign list which belong to your teams or the teams you are member

Required headers

`Content-Type`	[String, Required]. Value is: application/json
`Authorization`	[String, Required]. Value is: Bearer [access_token]

Possible parameters

`teamId`	[String, Optional]. Get teamId from Get team list API. Will list all campaigns belong to this team, if not specified it will return all campaigns of all team you are managing.
`size`	[Number, Optional]. The number of results each page, default 20 results.
`page`	[Number, Optional]. The page of results, default is 0. Start page is 0.

Examples

cURL Response

                    
									
curl -X POST https://api.shortenworld.com/v1/entity/campaign/list \
	 -H "Content-Type: application/json" \
	 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzaG9ydGVud29ybGQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiZXhwIjoxNjcxNjI1OTg3LCJ1c2VyIjp7ImlkIjoxMDEwLCJjaWYiOiJlYWUyZDc5NS0wYzZmLTQ2MWItYTZkNC1lYjRmYTUwOGI4YzkiLCJ1c2VybmFtZSI6InNob3J0ZW53b3JsZCIsImVtYWlsIjoic3VwcG9ydEBzaG9ydGVud29ybGQuY29tIiwiZnVsbE5hbWUiOiJI4buTbmcgTmh1bmciLCJsZXZlbCI6MCwibWFuYWdlciI6ZmFsc2UsImJhbmsiOmZhbHNlLCJ0b3RhbExvZ2luIjoxLCJ0b2RheUxvZ2luIjoxLCJsYXN0TG9naW5UaW1lIjpudWxsLCJsYXN0TG9naW5JcCI6bnVsbCwibGFzdExvZ2luRGV2aWNlIjpudWxsLCJsYXN0TG9naW5Mb2NhdGlvbiI6bnVsbCwibG9jYWxlIjoidmkifSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9VU0VSIl0sImp0aSI6IlB0R3ROd2hwcVMrSElLYnFoNEFhdlFkU1RPMD0iLCJjbGllbnRfaWQiOiJhcGlMaW5rIn0.B400MYwEdL5j9U4E3HGZ0SqQ6n38NwQvp7o2n-GROZyUZmEDPRQYDDa6v9AqVqbCdPuKbrWQv2QeU_PGHD5lcsx5RDvkHAPxhz8WNcAeYjgBC9uVYOQ8giMYotJ13b14jpUba5bdnoFB-ozvkqnnfZWStacYEDhbhbu8Udd2xtHp4CDwMEJDsV0UcOmCDw6MKAc4NFmKCXThXTi6FhxUlYS2YJ4WjXX94Gjiw5nnRRgeNSJQEAjkotTV3RPoi6VzQFL4hyp2zdzJxWtAKqTGEv2njBJG7CPN_4e71EJ5w6ovZ1OxTkHUBfugaQjoS4reZzJiBdUE2ONFfrfXT1Zc6A" \
	 -d '{"teamId":"6340e9c7a26da453b891b752","size":20,"page":0}'

                    
									
{
  "status": {
    "message": "Wow, successfully!",
    "code": 0,
    "timestamp": "2022-12-22T02:57:46+0000"
  },
  "campaigns": [
    {
      "id": "639e9cb181c0a87774a72038",
      "code": "new_year_flash_sale",
      "name": "New year flash sale",
      "links": 6,
      "teamId": "6340e9c7a26da453b891b752",
      "createdTime": "2022-12-18T04:53:05.112+0000"
    }
  ],
  "total": 1
}

To get pretty JSON response we can use format tool: https://format.asia/json-format

HTTP Status

`200`	Success
`401`	Unauthorized
`403`	Your account is locked or permission denied
`429`	Login too many failed
`500`	An unknown error

Json string will be sent, containing following data

`status => code: 0`	Success
`status => code: not equal 0`	Error
`status => message`	Error message
`status => timestamp`	The time server responses

Get domain subscriptions

We use this API to get all domain subscriptions which you have subscribed to your team. Both rent domains and your own domains

Required headers

`Content-Type`	[String, Required]. Value is: application/json
`Authorization`	[String, Required]. Value is: Bearer [access_token]

Possible parameters

`teamId`	[String, Required]. Get teamId from Get team list API.
`size`	[Number, Optional]. The number of results each page, default 20 results.
`page`	[Number, Optional]. The page of results, default is 0. Start page is 0.

Examples

cURL Response

                    
									
curl -X POST https://api.shortenworld.com/v1/entity/domain/subscriptions \
	 -H "Content-Type: application/json" \
	 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzaG9ydGVud29ybGQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiZXhwIjoxNjcxNjI1OTg3LCJ1c2VyIjp7ImlkIjoxMDEwLCJjaWYiOiJlYWUyZDc5NS0wYzZmLTQ2MWItYTZkNC1lYjRmYTUwOGI4YzkiLCJ1c2VybmFtZSI6InNob3J0ZW53b3JsZCIsImVtYWlsIjoic3VwcG9ydEBzaG9ydGVud29ybGQuY29tIiwiZnVsbE5hbWUiOiJI4buTbmcgTmh1bmciLCJsZXZlbCI6MCwibWFuYWdlciI6ZmFsc2UsImJhbmsiOmZhbHNlLCJ0b3RhbExvZ2luIjoxLCJ0b2RheUxvZ2luIjoxLCJsYXN0TG9naW5UaW1lIjpudWxsLCJsYXN0TG9naW5JcCI6bnVsbCwibGFzdExvZ2luRGV2aWNlIjpudWxsLCJsYXN0TG9naW5Mb2NhdGlvbiI6bnVsbCwibG9jYWxlIjoidmkifSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9VU0VSIl0sImp0aSI6IlB0R3ROd2hwcVMrSElLYnFoNEFhdlFkU1RPMD0iLCJjbGllbnRfaWQiOiJhcGlMaW5rIn0.B400MYwEdL5j9U4E3HGZ0SqQ6n38NwQvp7o2n-GROZyUZmEDPRQYDDa6v9AqVqbCdPuKbrWQv2QeU_PGHD5lcsx5RDvkHAPxhz8WNcAeYjgBC9uVYOQ8giMYotJ13b14jpUba5bdnoFB-ozvkqnnfZWStacYEDhbhbu8Udd2xtHp4CDwMEJDsV0UcOmCDw6MKAc4NFmKCXThXTi6FhxUlYS2YJ4WjXX94Gjiw5nnRRgeNSJQEAjkotTV3RPoi6VzQFL4hyp2zdzJxWtAKqTGEv2njBJG7CPN_4e71EJ5w6ovZ1OxTkHUBfugaQjoS4reZzJiBdUE2ONFfrfXT1Zc6A" \
	 -d '{"teamId":"6340e9c7a26da453b891b752","size":20,"page":0}'

                    
									
{
  "status": {
    "message": "Wow, successfully!",
    "code": 0,
    "timestamp": "2022-12-22T03:05:40+0000"
  },
  "subscriptions": [
    {
      "domainId": "63281bec3d2b0000ee0018c2",
      "domainName": "shorten.world",
      "status": "Y",
      "registerDate": null,
      "expiredDate": null,
      "domainOwner": "shortenworld"
    },
    {
      "domainId": "634cc5dbef3e000065005372",
      "domainName": "shorten.is",
      "status": "Y",
      "registerDate": null,
      "expiredDate": null,
      "domainOwner": "shortenworld"
    },
    {
      "domainId": "634cc5e7ef3e000065005373",
      "domainName": "shorten.ee",
      "status": "Y",
      "registerDate": null,
      "expiredDate": null,
      "domainOwner": "shortenworld"
    },
    {
      "domainId": "634cc5efef3e000065005374",
      "domainName": "shorten.tv",
      "status": "Y",
      "registerDate": null,
      "expiredDate": null,
      "domainOwner": "shortenworld"
    },
    {
      "domainId": "634cc5f4ef3e000065005375",
      "domainName": "shorten.so",
      "status": "Y",
      "registerDate": null,
      "expiredDate": null,
      "domainOwner": "shortenworld"
    },
    {
      "domainId": "634e6b85b4a38d0a28f9db41",
      "domainName": "enroll.vn",
      "status": "Y",
      "registerDate": "2022-12-14T03:30:24.073+0000",
      "expiredDate": "2023-02-12T03:30:24.073+0000",
      "domainOwner": "vn"
    },
    {
      "domainId": "6388779c76478b5c684f281b",
      "domainName": "voiceinsur.com",
      "status": "Y",
      "registerDate": "2022-12-01T11:32:29.891+0000",
      "expiredDate": null,
      "domainOwner": "megachat"
    },
    {
      "domainId": "638877af76478b5c684f281d",
      "domainName": "metadigie.com",
      "status": "Y",
      "registerDate": "2022-12-01T11:27:58.412+0000",
      "expiredDate": null,
      "domainOwner": "megachat"
    },
    {
      "domainId": "634e67e2b4a38d0a28f9db34",
      "domainName": "than.world",
      "status": "E",
      "registerDate": "2022-10-20T09:10:29.662+0000",
      "expiredDate": "2022-12-20T09:10:29.662+0000",
      "domainOwner": "world"
    },
    {
      "domainId": "634cdd1ce746c91a90c5a015",
      "domainName": "bigbang.to",
      "status": "E",
      "registerDate": "2022-10-20T02:52:08.188+0000",
      "expiredDate": "2022-11-19T02:52:08.188+0000",
      "domainOwner": "centre"
    },
    {
      "domainId": "634e66dcb4a38d0a28f9db2b",
      "domainName": "cut.vin",
      "status": "Y",
      "registerDate": "2022-10-19T07:33:47.803+0000",
      "expiredDate": "2023-02-16T07:33:47.803+0000",
      "domainOwner": "cut"
    },
    {
      "domainId": "634e6be6b4a38d0a28f9db4f",
      "domainName": "redirect.vn",
      "status": "Y",
      "registerDate": "2022-12-03T03:12:32.446+0000",
      "expiredDate": "2023-08-30T03:12:32.446+0000",
      "domainOwner": "vn"
    }
  ],
  "total": 7
}

To get pretty JSON response we can use format tool: https://format.asia/json-format

HTTP Status

`200`	Success
`401`	Unauthorized
`403`	Your account is locked or permission denied
`429`	Login too many failed
`500`	An unknown error

Json string will be sent, containing following data

`status => code: 0`	Success
`status => code: not equal 0`	Error
`status => message`	Error message
`status => timestamp`	The time server responses

Get link list

We use this API to get all your links which belong to your teams or the teams you are member

Required headers

`Content-Type`	[String, Required]. Value is: application/json
`Authorization`	[String, Required]. Value is: Bearer [access_token]

Possible parameters

`teamId`	[String, Optional]. Get teamId from Get team list API.
`domainIds`	[Many Strings. Separate by comma "," , Optional]. Get domainId from Get domain subscriptions API.
`campaignIds`	[Many Strings. Separate by comma "," , Optional]. Get campaignId from Get campaign list API.
`hidden`	[String, Optional]. Value is: true or false. If value is true, it will return all hidden links
`search`	[String, Optional]. Full text search with link code and link title
`size`	[Number, Optional]. The number of results each page, default 20 results.
`page`	[Number, Optional]. The page of results, default is 0. Start page is 0.

Examples

cURL Response

                    
									
curl -X POST https://api.shortenworld.com/v1/entity/link/list \
	 -H "Content-Type: application/json" \
	 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzaG9ydGVud29ybGQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiZXhwIjoxNjcxNjI1OTg3LCJ1c2VyIjp7ImlkIjoxMDEwLCJjaWYiOiJlYWUyZDc5NS0wYzZmLTQ2MWItYTZkNC1lYjRmYTUwOGI4YzkiLCJ1c2VybmFtZSI6InNob3J0ZW53b3JsZCIsImVtYWlsIjoic3VwcG9ydEBzaG9ydGVud29ybGQuY29tIiwiZnVsbE5hbWUiOiJI4buTbmcgTmh1bmciLCJsZXZlbCI6MCwibWFuYWdlciI6ZmFsc2UsImJhbmsiOmZhbHNlLCJ0b3RhbExvZ2luIjoxLCJ0b2RheUxvZ2luIjoxLCJsYXN0TG9naW5UaW1lIjpudWxsLCJsYXN0TG9naW5JcCI6bnVsbCwibGFzdExvZ2luRGV2aWNlIjpudWxsLCJsYXN0TG9naW5Mb2NhdGlvbiI6bnVsbCwibG9jYWxlIjoidmkifSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9VU0VSIl0sImp0aSI6IlB0R3ROd2hwcVMrSElLYnFoNEFhdlFkU1RPMD0iLCJjbGllbnRfaWQiOiJhcGlMaW5rIn0.B400MYwEdL5j9U4E3HGZ0SqQ6n38NwQvp7o2n-GROZyUZmEDPRQYDDa6v9AqVqbCdPuKbrWQv2QeU_PGHD5lcsx5RDvkHAPxhz8WNcAeYjgBC9uVYOQ8giMYotJ13b14jpUba5bdnoFB-ozvkqnnfZWStacYEDhbhbu8Udd2xtHp4CDwMEJDsV0UcOmCDw6MKAc4NFmKCXThXTi6FhxUlYS2YJ4WjXX94Gjiw5nnRRgeNSJQEAjkotTV3RPoi6VzQFL4hyp2zdzJxWtAKqTGEv2njBJG7CPN_4e71EJ5w6ovZ1OxTkHUBfugaQjoS4reZzJiBdUE2ONFfrfXT1Zc6A" \
	 -d '{"teamId":"6340e9c7a26da453b891b752","domainIds":"63281bec3d2b0000ee0018c2","campaignIds":"","hidden":"false","search":"","size":3,"page":0}'

                    
									
{
  "status": {
    "message": "Wow, successfully!",
    "code": 0,
    "timestamp": "2022-12-22T03:24:56+0000"
  },
  "links": [
    {
      "id": "63a02eff5c9ec550a4f7b1b0",
      "code": "tPl1N",
      "url": "https://shorten.world/tPl1N",
      "destination": "https://format.asia/json-formats",
      "title": "cxc",
      "password": "234",
      "clickType": 1,
      "uniqueTime": 10,
      "api": true,
      "status": "Y",
      "domainId": "63281bec3d2b0000ee0018c2",
      "campaignId": null,
      "teamId": "6340e9c7a26da453b891b752",
      "tags": null,
      "createdTime": "2022-12-19T09:29:35.523+0000"
    },
    {
      "id": "63a02ebf5c9ec550a4f7b1af",
      "code": "vRiPT",
      "url": "https://shorten.world/vRiPT",
      "destination": "https://format.asia/json-format",
      "title": "JSON Formatter, JSON Beautifier, JSON Minifier, JSON Validator, JSON Converter Online | Format.asia",
      "password": null,
      "clickType": 0,
      "uniqueTime": null,
      "api": true,
      "status": "Y",
      "domainId": "63281bec3d2b0000ee0018c2",
      "campaignId": null,
      "teamId": "6340e9c7a26da453b891b752",
      "tags": null,
      "createdTime": "2022-12-19T09:28:31.730+0000"
    },
    {
      "id": "63a02ea45c9ec550a4f7b1ae",
      "code": "JVlW8",
      "url": "https://shorten.world/JVlW8",
      "destination": "https://format.asia/json-format",
      "title": "JSON Formatter, JSON Beautifier, JSON Minifier, JSON Validator, JSON Converter Online | Format.asia",
      "password": null,
      "clickType": 0,
      "uniqueTime": null,
      "api": true,
      "status": "Y",
      "domainId": "63281bec3d2b0000ee0018c2",
      "campaignId": null,
      "teamId": "6340e9c7a26da453b891b752",
      "tags": null,
      "createdTime": "2022-12-19T09:28:04.692+0000"
    }
  ],
  "total": 29
}

To get pretty JSON response we can use format tool: https://format.asia/json-format

HTTP Status

`200`	Success
`401`	Unauthorized
`403`	Your account is locked or permission denied
`429`	Login too many failed
`500`	An unknown error

Json string will be sent, containing following data

`status => code: 0`	Success
`status => code: not equal 0`	Error
`status => message`	Error message
`status => timestamp`	The time server responses

Create link

We use this API to shorten link

Required headers

`Content-Type`	[String, Required]. Value is: application/json
`Authorization`	[String, Required]. Value is: Bearer [access_token]

Possible parameters

`teamId`	[String, Required]. Get teamId from Get team list API.
`domainId`	[String, Required]. Get domainId from Get domain subscriptions API.
`campaignId`	[String, Optional]. Get campaignId from Get campaign list API.
`noTitle`	[Boolean, Optional]. Value is: true or false. If value is true it will disable getting the page title from the source page meta tag which results in faster API response time (Check subscription plan)
`destination`	[String, Required]. Your long link to shorten
`utmSource`	[String, Optional]. Campaign Source
`utmMedium`	[String, Optional]. Campaign Medium
`utmCampaign`	[String, Optional]. Campaign Name
`utmTerm`	[String, Optional]. Campaign Term
`utmContent`	[String, Optional]. Campaign Content

Examples

cURL Response

                    
									
curl -X POST https://api.shortenworld.com/v1/entity/link/create \
	 -H "Content-Type: application/json" \
	 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzaG9ydGVud29ybGQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiZXhwIjoxNjcxNjI1OTg3LCJ1c2VyIjp7ImlkIjoxMDEwLCJjaWYiOiJlYWUyZDc5NS0wYzZmLTQ2MWItYTZkNC1lYjRmYTUwOGI4YzkiLCJ1c2VybmFtZSI6InNob3J0ZW53b3JsZCIsImVtYWlsIjoic3VwcG9ydEBzaG9ydGVud29ybGQuY29tIiwiZnVsbE5hbWUiOiJI4buTbmcgTmh1bmciLCJsZXZlbCI6MCwibWFuYWdlciI6ZmFsc2UsImJhbmsiOmZhbHNlLCJ0b3RhbExvZ2luIjoxLCJ0b2RheUxvZ2luIjoxLCJsYXN0TG9naW5UaW1lIjpudWxsLCJsYXN0TG9naW5JcCI6bnVsbCwibGFzdExvZ2luRGV2aWNlIjpudWxsLCJsYXN0TG9naW5Mb2NhdGlvbiI6bnVsbCwibG9jYWxlIjoidmkifSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9VU0VSIl0sImp0aSI6IlB0R3ROd2hwcVMrSElLYnFoNEFhdlFkU1RPMD0iLCJjbGllbnRfaWQiOiJhcGlMaW5rIn0.B400MYwEdL5j9U4E3HGZ0SqQ6n38NwQvp7o2n-GROZyUZmEDPRQYDDa6v9AqVqbCdPuKbrWQv2QeU_PGHD5lcsx5RDvkHAPxhz8WNcAeYjgBC9uVYOQ8giMYotJ13b14jpUba5bdnoFB-ozvkqnnfZWStacYEDhbhbu8Udd2xtHp4CDwMEJDsV0UcOmCDw6MKAc4NFmKCXThXTi6FhxUlYS2YJ4WjXX94Gjiw5nnRRgeNSJQEAjkotTV3RPoi6VzQFL4hyp2zdzJxWtAKqTGEv2njBJG7CPN_4e71EJ5w6ovZ1OxTkHUBfugaQjoS4reZzJiBdUE2ONFfrfXT1Zc6A" \
	 -d '{"teamId":"6340e9c7a26da453b891b752","domainId":"63281bec3d2b0000ee0018c2","campaignId":"639e9cb181c0a87774a72038","noTitle":false,"destination":"https://format.asia/json-format","utmSource":"","utmMedium":"","utmCampaign":"","utmTerm":"","utmContent":""}'

                    
									
{
  "status": {
    "message": "Wow, successfully!",
    "code": 0,
    "timestamp": "2022-12-22T03:44:47+0000"
  },
  "linkId": "63a3d2af450da672f48d90ff"
}

To get pretty JSON response we can use format tool: https://format.asia/json-format

HTTP Status

`200`	Success
`401`	Unauthorized
`403`	Your account is locked or permission denied
`429`	Login too many failed
`500`	An unknown error

Json string will be sent, containing following data

`status => code: 0`	Success
`status => code: not equal 0`	Error
`status => message`	Error message
`status => timestamp`	The time server responses

Update link

We use this API to update link

Required headers

`Content-Type`	[String, Required]. Value is: application/json
`Authorization`	[String, Required]. Value is: Bearer [access_token]

Possible parameters

`linkId`	[String, Required]. Get linkId from Get link list API or Create link api.
`title`	[String, Optional]. Change title.
`code`	[String, Optional]. Change code (Back-half of the link).
`tags`	[Boolean, Optional]. Add tag for link
`hide`	[String, Optional]. Value is "on" or "off". If "on" it will be hidden from the Dashboard

Examples

cURL Response

                    
									
curl -X POST https://api.shortenworld.com/v1/entity/link/update \
	 -H "Content-Type: application/json" \
	 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzaG9ydGVud29ybGQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiZXhwIjoxNjcxNjI1OTg3LCJ1c2VyIjp7ImlkIjoxMDEwLCJjaWYiOiJlYWUyZDc5NS0wYzZmLTQ2MWItYTZkNC1lYjRmYTUwOGI4YzkiLCJ1c2VybmFtZSI6InNob3J0ZW53b3JsZCIsImVtYWlsIjoic3VwcG9ydEBzaG9ydGVud29ybGQuY29tIiwiZnVsbE5hbWUiOiJI4buTbmcgTmh1bmciLCJsZXZlbCI6MCwibWFuYWdlciI6ZmFsc2UsImJhbmsiOmZhbHNlLCJ0b3RhbExvZ2luIjoxLCJ0b2RheUxvZ2luIjoxLCJsYXN0TG9naW5UaW1lIjpudWxsLCJsYXN0TG9naW5JcCI6bnVsbCwibGFzdExvZ2luRGV2aWNlIjpudWxsLCJsYXN0TG9naW5Mb2NhdGlvbiI6bnVsbCwibG9jYWxlIjoidmkifSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9VU0VSIl0sImp0aSI6IlB0R3ROd2hwcVMrSElLYnFoNEFhdlFkU1RPMD0iLCJjbGllbnRfaWQiOiJhcGlMaW5rIn0.B400MYwEdL5j9U4E3HGZ0SqQ6n38NwQvp7o2n-GROZyUZmEDPRQYDDa6v9AqVqbCdPuKbrWQv2QeU_PGHD5lcsx5RDvkHAPxhz8WNcAeYjgBC9uVYOQ8giMYotJ13b14jpUba5bdnoFB-ozvkqnnfZWStacYEDhbhbu8Udd2xtHp4CDwMEJDsV0UcOmCDw6MKAc4NFmKCXThXTi6FhxUlYS2YJ4WjXX94Gjiw5nnRRgeNSJQEAjkotTV3RPoi6VzQFL4hyp2zdzJxWtAKqTGEv2njBJG7CPN_4e71EJ5w6ovZ1OxTkHUBfugaQjoS4reZzJiBdUE2ONFfrfXT1Zc6A" \
	 -d '{"linkId":"63a3d2af450da672f48d90ff","title":"","code":"","tags":"landing_page","hide":""}'

                    
									
{
  "status": {
    "message": "Wow, successfully!",
    "code": 0,
    "timestamp": "2022-12-22T03:55:12+0000"
  }
}

To get pretty JSON response we can use format tool: https://format.asia/json-format

HTTP Status

`200`	Success
`401`	Unauthorized
`403`	Your account is locked or permission denied
`429`	Login too many failed
`500`	An unknown error

Json string will be sent, containing following data

`status => code: 0`	Success
`status => code: not equal 0`	Error
`status => message`	Error message
`status => timestamp`	The time server responses

Delete link

We use this API to delete link

Required headers

`Content-Type`	[String, Required]. Value is: application/json
`Authorization`	[String, Required]. Value is: Bearer [access_token]

Possible parameters

linkId [String, Required]. Get linkId from Get link list API or Create link api.

Examples

cURL Response

                    
									
curl -X POST https://api.shortenworld.com/v1/entity/link/delete \
	 -H "Content-Type: application/json" \
	 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzaG9ydGVud29ybGQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiZXhwIjoxNjcxNjI1OTg3LCJ1c2VyIjp7ImlkIjoxMDEwLCJjaWYiOiJlYWUyZDc5NS0wYzZmLTQ2MWItYTZkNC1lYjRmYTUwOGI4YzkiLCJ1c2VybmFtZSI6InNob3J0ZW53b3JsZCIsImVtYWlsIjoic3VwcG9ydEBzaG9ydGVud29ybGQuY29tIiwiZnVsbE5hbWUiOiJI4buTbmcgTmh1bmciLCJsZXZlbCI6MCwibWFuYWdlciI6ZmFsc2UsImJhbmsiOmZhbHNlLCJ0b3RhbExvZ2luIjoxLCJ0b2RheUxvZ2luIjoxLCJsYXN0TG9naW5UaW1lIjpudWxsLCJsYXN0TG9naW5JcCI6bnVsbCwibGFzdExvZ2luRGV2aWNlIjpudWxsLCJsYXN0TG9naW5Mb2NhdGlvbiI6bnVsbCwibG9jYWxlIjoidmkifSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9VU0VSIl0sImp0aSI6IlB0R3ROd2hwcVMrSElLYnFoNEFhdlFkU1RPMD0iLCJjbGllbnRfaWQiOiJhcGlMaW5rIn0.B400MYwEdL5j9U4E3HGZ0SqQ6n38NwQvp7o2n-GROZyUZmEDPRQYDDa6v9AqVqbCdPuKbrWQv2QeU_PGHD5lcsx5RDvkHAPxhz8WNcAeYjgBC9uVYOQ8giMYotJ13b14jpUba5bdnoFB-ozvkqnnfZWStacYEDhbhbu8Udd2xtHp4CDwMEJDsV0UcOmCDw6MKAc4NFmKCXThXTi6FhxUlYS2YJ4WjXX94Gjiw5nnRRgeNSJQEAjkotTV3RPoi6VzQFL4hyp2zdzJxWtAKqTGEv2njBJG7CPN_4e71EJ5w6ovZ1OxTkHUBfugaQjoS4reZzJiBdUE2ONFfrfXT1Zc6A" \
	 -d '{"linkId":"63a3d2af450da672f48d90ff"}'

                    
									
{
  "status": {
    "message": "Wow, successfully!",
    "code": 0,
    "timestamp": "2022-12-22T03:58:53+0000"
  }
}

To get pretty JSON response we can use format tool: https://format.asia/json-format

HTTP Status

`200`	Success
`401`	Unauthorized
`403`	Your account is locked or permission denied
`429`	Login too many failed
`500`	An unknown error

Json string will be sent, containing following data

`status => code: 0`	Success
`status => code: not equal 0`	Error
`status => message`	Error message
`status => timestamp`	The time server responses

Redirect link

We use this API to redirect link, change destination, change click type or update UTM Campaign

Required headers

`Content-Type`	[String, Required]. Value is: application/json
`Authorization`	[String, Required]. Value is: Bearer [access_token]

Possible parameters

`linkId`	[String, Required]. Get linkId from Get link list API or Create link api.
`destination`	[String, Optional]. Your new long link to redirect
`clickType`	[Number, Optional]. If value is "0" it will count on All clicks. If value is "1" it will count on Unique clicks.
`uniqueTime`	[Number, Optional]. if clickType above is "1", this will handle how Unique clicks work. Let's say uniqueTime = 15 (minutes), if user click on the link consecutively we only count each 15 minutes is one click
`utmSource`	[String, Optional]. Campaign Source
`utmMedium`	[String, Optional]. Campaign Medium
`utmCampaign`	[String, Optional]. Campaign Name
`utmTerm`	[String, Optional]. Campaign Term
`utmContent`	[String, Optional]. Campaign Content

Examples

cURL Response

                    
									
curl -X POST https://api.shortenworld.com/v1/entity/link/redirect \
	 -H "Content-Type: application/json" \
	 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzaG9ydGVud29ybGQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiZXhwIjoxNjcxNjI1OTg3LCJ1c2VyIjp7ImlkIjoxMDEwLCJjaWYiOiJlYWUyZDc5NS0wYzZmLTQ2MWItYTZkNC1lYjRmYTUwOGI4YzkiLCJ1c2VybmFtZSI6InNob3J0ZW53b3JsZCIsImVtYWlsIjoic3VwcG9ydEBzaG9ydGVud29ybGQuY29tIiwiZnVsbE5hbWUiOiJI4buTbmcgTmh1bmciLCJsZXZlbCI6MCwibWFuYWdlciI6ZmFsc2UsImJhbmsiOmZhbHNlLCJ0b3RhbExvZ2luIjoxLCJ0b2RheUxvZ2luIjoxLCJsYXN0TG9naW5UaW1lIjpudWxsLCJsYXN0TG9naW5JcCI6bnVsbCwibGFzdExvZ2luRGV2aWNlIjpudWxsLCJsYXN0TG9naW5Mb2NhdGlvbiI6bnVsbCwibG9jYWxlIjoidmkifSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9VU0VSIl0sImp0aSI6IlB0R3ROd2hwcVMrSElLYnFoNEFhdlFkU1RPMD0iLCJjbGllbnRfaWQiOiJhcGlMaW5rIn0.B400MYwEdL5j9U4E3HGZ0SqQ6n38NwQvp7o2n-GROZyUZmEDPRQYDDa6v9AqVqbCdPuKbrWQv2QeU_PGHD5lcsx5RDvkHAPxhz8WNcAeYjgBC9uVYOQ8giMYotJ13b14jpUba5bdnoFB-ozvkqnnfZWStacYEDhbhbu8Udd2xtHp4CDwMEJDsV0UcOmCDw6MKAc4NFmKCXThXTi6FhxUlYS2YJ4WjXX94Gjiw5nnRRgeNSJQEAjkotTV3RPoi6VzQFL4hyp2zdzJxWtAKqTGEv2njBJG7CPN_4e71EJ5w6ovZ1OxTkHUBfugaQjoS4reZzJiBdUE2ONFfrfXT1Zc6A" \
	 -d '{"linkId":"63a3d2af450da672f48d90ff","destination":"https://format.asia/json-formats","clickType":1,"uniqueTime":15,"utmSource":"newsletter","utmMedium":"","utmCampaign":"","utmTerm":"","utmContent":""}'

                    
									
{
  "status": {
    "message": "Wow, successfully!",
    "code": 0,
    "timestamp": "2022-12-22T04:30:22+0000"
  }
}

To get pretty JSON response we can use format tool: https://format.asia/json-format

HTTP Status

`200`	Success
`401`	Unauthorized
`403`	Your account is locked or permission denied
`429`	Login too many failed
`500`	An unknown error

Json string will be sent, containing following data

`status => code: 0`	Success
`status => code: not equal 0`	Error
`status => message`	Error message
`status => timestamp`	The time server responses

Redirect mobile link

This API will redirect link separately on each mobile platform

Required headers

`Content-Type`	[String, Required]. Value is: application/json
`Authorization`	[String, Required]. Value is: Bearer [access_token]

Possible parameters

`linkId`	[String, Required]. Get linkId from Get link list API or Create link api.
`ios`	[String, Optional]. If device of the user is IOS platform, the link will redirect to this destination
`android`	[String, Optional]. If device of the user is android platform, the link will redirect to this destination
`windows`	[String, Optional]. If device of the user is windows phone platform, the link will redirect to this destination
`mobile`	[String, Optional]. If device of the user is mobile and not one of above platforms, the link will redirect to this destination

Examples

cURL Response

                    
									
curl -X POST https://api.shortenworld.com/v1/entity/link/redirect-mobile \
	 -H "Content-Type: application/json" \
	 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzaG9ydGVud29ybGQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiZXhwIjoxNjcxNjI1OTg3LCJ1c2VyIjp7ImlkIjoxMDEwLCJjaWYiOiJlYWUyZDc5NS0wYzZmLTQ2MWItYTZkNC1lYjRmYTUwOGI4YzkiLCJ1c2VybmFtZSI6InNob3J0ZW53b3JsZCIsImVtYWlsIjoic3VwcG9ydEBzaG9ydGVud29ybGQuY29tIiwiZnVsbE5hbWUiOiJI4buTbmcgTmh1bmciLCJsZXZlbCI6MCwibWFuYWdlciI6ZmFsc2UsImJhbmsiOmZhbHNlLCJ0b3RhbExvZ2luIjoxLCJ0b2RheUxvZ2luIjoxLCJsYXN0TG9naW5UaW1lIjpudWxsLCJsYXN0TG9naW5JcCI6bnVsbCwibGFzdExvZ2luRGV2aWNlIjpudWxsLCJsYXN0TG9naW5Mb2NhdGlvbiI6bnVsbCwibG9jYWxlIjoidmkifSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9VU0VSIl0sImp0aSI6IlB0R3ROd2hwcVMrSElLYnFoNEFhdlFkU1RPMD0iLCJjbGllbnRfaWQiOiJhcGlMaW5rIn0.B400MYwEdL5j9U4E3HGZ0SqQ6n38NwQvp7o2n-GROZyUZmEDPRQYDDa6v9AqVqbCdPuKbrWQv2QeU_PGHD5lcsx5RDvkHAPxhz8WNcAeYjgBC9uVYOQ8giMYotJ13b14jpUba5bdnoFB-ozvkqnnfZWStacYEDhbhbu8Udd2xtHp4CDwMEJDsV0UcOmCDw6MKAc4NFmKCXThXTi6FhxUlYS2YJ4WjXX94Gjiw5nnRRgeNSJQEAjkotTV3RPoi6VzQFL4hyp2zdzJxWtAKqTGEv2njBJG7CPN_4e71EJ5w6ovZ1OxTkHUBfugaQjoS4reZzJiBdUE2ONFfrfXT1Zc6A" \
	 -d '{"linkId":"63a3d2af450da672f48d90ff","ios":"https://format.asia/xml-format","android":"https://format.asia/javascript-format","windows":"https://format.asia/css-format","mobile":"https://format.asia/md5-hash-generator"}}'

                    
									
{
  "status": {
    "message": "Wow, successfully!",
    "code": 0,
    "timestamp": "2022-12-22T04:39:43+0000"
  }
}

To get pretty JSON response we can use format tool: https://format.asia/json-format

HTTP Status

`200`	Success
`401`	Unauthorized
`403`	Your account is locked or permission denied
`429`	Login too many failed
`500`	An unknown error

Json string will be sent, containing following data

`status => code: 0`	Success
`status => code: not equal 0`	Error
`status => message`	Error message
`status => timestamp`	The time server responses

Expiration link

This API will set expiration of the link by time or number of clicks

Required headers

`Content-Type`	[String, Required]. Value is: application/json
`Authorization`	[String, Required]. Value is: Bearer [access_token]

Possible parameters

`linkId`	[String, Required]. Get linkId from Get link list API or Create link api.
`date`	[String, Optional]. The date to be expired, format: dd/MM/yyyy
`destinationByDate`	[String, Optional]. The link will redirect to this destination after above `date`
`click`	[Number, Optional]. Number of clicks to be expired
`clickType`	[Number, Optional]. If value is "0", `click` above will count on All clicks. If value is "1" `click` above will count on Unique clicks.
`destinationByClick`	[String, Optional]. If number of clicks more than `click` above, the link will redirect to this destination

Examples

cURL Response

                    
									
curl -X POST https://api.shortenworld.com/v1/entity/link/expiration \
	 -H "Content-Type: application/json" \
	 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzaG9ydGVud29ybGQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiZXhwIjoxNjcxNjI1OTg3LCJ1c2VyIjp7ImlkIjoxMDEwLCJjaWYiOiJlYWUyZDc5NS0wYzZmLTQ2MWItYTZkNC1lYjRmYTUwOGI4YzkiLCJ1c2VybmFtZSI6InNob3J0ZW53b3JsZCIsImVtYWlsIjoic3VwcG9ydEBzaG9ydGVud29ybGQuY29tIiwiZnVsbE5hbWUiOiJI4buTbmcgTmh1bmciLCJsZXZlbCI6MCwibWFuYWdlciI6ZmFsc2UsImJhbmsiOmZhbHNlLCJ0b3RhbExvZ2luIjoxLCJ0b2RheUxvZ2luIjoxLCJsYXN0TG9naW5UaW1lIjpudWxsLCJsYXN0TG9naW5JcCI6bnVsbCwibGFzdExvZ2luRGV2aWNlIjpudWxsLCJsYXN0TG9naW5Mb2NhdGlvbiI6bnVsbCwibG9jYWxlIjoidmkifSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9VU0VSIl0sImp0aSI6IlB0R3ROd2hwcVMrSElLYnFoNEFhdlFkU1RPMD0iLCJjbGllbnRfaWQiOiJhcGlMaW5rIn0.B400MYwEdL5j9U4E3HGZ0SqQ6n38NwQvp7o2n-GROZyUZmEDPRQYDDa6v9AqVqbCdPuKbrWQv2QeU_PGHD5lcsx5RDvkHAPxhz8WNcAeYjgBC9uVYOQ8giMYotJ13b14jpUba5bdnoFB-ozvkqnnfZWStacYEDhbhbu8Udd2xtHp4CDwMEJDsV0UcOmCDw6MKAc4NFmKCXThXTi6FhxUlYS2YJ4WjXX94Gjiw5nnRRgeNSJQEAjkotTV3RPoi6VzQFL4hyp2zdzJxWtAKqTGEv2njBJG7CPN_4e71EJ5w6ovZ1OxTkHUBfugaQjoS4reZzJiBdUE2ONFfrfXT1Zc6A" \
	 -d '{"linkId":"63a3d2af450da672f48d90ff","date":"10/10/2023","destinationByDate":"https://format.asia/html-encode","click":100,"clickType":1,"destinationByClick":"https://format.asia/base64-encode"}}'

                    
									
{
  "status": {
    "message": "Wow, successfully!",
    "code": 0,
    "timestamp": "2022-12-22T04:56:06+0000"
  }
}

To get pretty JSON response we can use format tool: https://format.asia/json-format

HTTP Status

`200`	Success
`401`	Unauthorized
`403`	Your account is locked or permission denied
`429`	Login too many failed
`500`	An unknown error

Json string will be sent, containing following data

`status => code: 0`	Success
`status => code: not equal 0`	Error
`status => message`	Error message
`status => timestamp`	The time server responses

Link password

This API will set password of the link. Users have to fill password before go to destination

Required headers

`Content-Type`	[String, Required]. Value is: application/json
`Authorization`	[String, Required]. Value is: Bearer [access_token]

Possible parameters

`linkId`	[String, Required]. Get linkId from Get link list API or Create link api.
`password`	[String, Required]. The password to open link

Examples

cURL Response

                    
									
curl -X POST https://api.shortenworld.com/v1/entity/link/password \
	 -H "Content-Type: application/json" \
	 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzaG9ydGVud29ybGQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiZXhwIjoxNjcxNjI1OTg3LCJ1c2VyIjp7ImlkIjoxMDEwLCJjaWYiOiJlYWUyZDc5NS0wYzZmLTQ2MWItYTZkNC1lYjRmYTUwOGI4YzkiLCJ1c2VybmFtZSI6InNob3J0ZW53b3JsZCIsImVtYWlsIjoic3VwcG9ydEBzaG9ydGVud29ybGQuY29tIiwiZnVsbE5hbWUiOiJI4buTbmcgTmh1bmciLCJsZXZlbCI6MCwibWFuYWdlciI6ZmFsc2UsImJhbmsiOmZhbHNlLCJ0b3RhbExvZ2luIjoxLCJ0b2RheUxvZ2luIjoxLCJsYXN0TG9naW5UaW1lIjpudWxsLCJsYXN0TG9naW5JcCI6bnVsbCwibGFzdExvZ2luRGV2aWNlIjpudWxsLCJsYXN0TG9naW5Mb2NhdGlvbiI6bnVsbCwibG9jYWxlIjoidmkifSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9VU0VSIl0sImp0aSI6IlB0R3ROd2hwcVMrSElLYnFoNEFhdlFkU1RPMD0iLCJjbGllbnRfaWQiOiJhcGlMaW5rIn0.B400MYwEdL5j9U4E3HGZ0SqQ6n38NwQvp7o2n-GROZyUZmEDPRQYDDa6v9AqVqbCdPuKbrWQv2QeU_PGHD5lcsx5RDvkHAPxhz8WNcAeYjgBC9uVYOQ8giMYotJ13b14jpUba5bdnoFB-ozvkqnnfZWStacYEDhbhbu8Udd2xtHp4CDwMEJDsV0UcOmCDw6MKAc4NFmKCXThXTi6FhxUlYS2YJ4WjXX94Gjiw5nnRRgeNSJQEAjkotTV3RPoi6VzQFL4hyp2zdzJxWtAKqTGEv2njBJG7CPN_4e71EJ5w6ovZ1OxTkHUBfugaQjoS4reZzJiBdUE2ONFfrfXT1Zc6A" \
	 -d '{"linkId":"63a3d2af450da672f48d90ff","password":"238"}'

                    
									
{
  "status": {
    "message": "Wow, successfully!",
    "code": 0,
    "timestamp": "2022-12-22T04:58:06+0000"
  }
}

To get pretty JSON response we can use format tool: https://format.asia/json-format

HTTP Status

`200`	Success
`401`	Unauthorized
`403`	Your account is locked or permission denied
`429`	Login too many failed
`500`	An unknown error

Json string will be sent, containing following data

`status => code: 0`	Success
`status => code: not equal 0`	Error
`status => message`	Error message
`status => timestamp`	The time server responses

Get tracker list

This API will get tracker list. Embedding retargeting tracker will help you track all your traffics to other tools to analyze. Including Facebook Pixel, Google Analytics Pixel, Quora Pixel, Twitter Pixel, Google Tag Manager Pixel, Linkedin Pixel, Google Adwords Pixel, Pinterest Pixel, Segment Pixel...

Required headers

`Content-Type`	[String, Required]. Value is: application/json
`Authorization`	[String, Required]. Value is: Bearer [access_token]

Possible parameters

Examples

cURL Response

                    
									
curl -X POST https://api.shortenworld.com/v1/entity/tracker/list \
	 -H "Content-Type: application/json" \
	 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzaG9ydGVud29ybGQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiZXhwIjoxNjcxNjI1OTg3LCJ1c2VyIjp7ImlkIjoxMDEwLCJjaWYiOiJlYWUyZDc5NS0wYzZmLTQ2MWItYTZkNC1lYjRmYTUwOGI4YzkiLCJ1c2VybmFtZSI6InNob3J0ZW53b3JsZCIsImVtYWlsIjoic3VwcG9ydEBzaG9ydGVud29ybGQuY29tIiwiZnVsbE5hbWUiOiJI4buTbmcgTmh1bmciLCJsZXZlbCI6MCwibWFuYWdlciI6ZmFsc2UsImJhbmsiOmZhbHNlLCJ0b3RhbExvZ2luIjoxLCJ0b2RheUxvZ2luIjoxLCJsYXN0TG9naW5UaW1lIjpudWxsLCJsYXN0TG9naW5JcCI6bnVsbCwibGFzdExvZ2luRGV2aWNlIjpudWxsLCJsYXN0TG9naW5Mb2NhdGlvbiI6bnVsbCwibG9jYWxlIjoidmkifSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9VU0VSIl0sImp0aSI6IlB0R3ROd2hwcVMrSElLYnFoNEFhdlFkU1RPMD0iLCJjbGllbnRfaWQiOiJhcGlMaW5rIn0.B400MYwEdL5j9U4E3HGZ0SqQ6n38NwQvp7o2n-GROZyUZmEDPRQYDDa6v9AqVqbCdPuKbrWQv2QeU_PGHD5lcsx5RDvkHAPxhz8WNcAeYjgBC9uVYOQ8giMYotJ13b14jpUba5bdnoFB-ozvkqnnfZWStacYEDhbhbu8Udd2xtHp4CDwMEJDsV0UcOmCDw6MKAc4NFmKCXThXTi6FhxUlYS2YJ4WjXX94Gjiw5nnRRgeNSJQEAjkotTV3RPoi6VzQFL4hyp2zdzJxWtAKqTGEv2njBJG7CPN_4e71EJ5w6ovZ1OxTkHUBfugaQjoS4reZzJiBdUE2ONFfrfXT1Zc6A" \
	 -d '{}'

                    
									
{
  "status": {
    "message": "Wow, successfully!",
    "code": 0,
    "timestamp": "2022-12-22T05:14:40+0000"
  },
  "trackers": [
    {
      "id": "635a1844172e000047005862",
      "name": "Facebook Pixel"
    },
    {
      "id": "635a184a172e000047005863",
      "name": "Google Analytics Pixel"
    },
    {
      "id": "635a185e172e000047005864",
      "name": "Quora Pixel"
    },
    {
      "id": "635a1863172e000047005865",
      "name": "Twitter Pixel"
    },
    {
      "id": "635a1869172e000047005866",
      "name": "Google Tag Manager Pixel"
    },
    {
      "id": "635a186f172e000047005867",
      "name": "Linkedin Pixel"
    },
    {
      "id": "635a1875172e000047005868",
      "name": "Google Adwords Pixel"
    },
    {
      "id": "635a188d172e000047005869",
      "name": "Pinterest Pixel"
    },
    {
      "id": "635a1892172e00004700586a",
      "name": "Segment Pixel"
    }
  ]
}

To get pretty JSON response we can use format tool: https://format.asia/json-format

HTTP Status

`200`	Success
`401`	Unauthorized
`403`	Your account is locked or permission denied
`429`	Login too many failed
`500`	An unknown error

Json string will be sent, containing following data

`status => code: 0`	Success
`status => code: not equal 0`	Error
`status => message`	Error message
`status => timestamp`	The time server responses

Get team tracker list

This API will get team tracker list. We can create team tracker from the dashboard.

Required headers

`Content-Type`	[String, Required]. Value is: application/json
`Authorization`	[String, Required]. Value is: Bearer [access_token]

Possible parameters

`teamId`	[String, Required]. Get teamId from Get team list API.
`size`	[Number, Optional]. The number of results each page, default 20 results.
`page`	[Number, Optional]. The page of results, default is 0. Start page is 0.

Examples

cURL Response

                    
									
curl -X POST https://api.shortenworld.com/v1/entity/team/tracker/list \
	 -H "Content-Type: application/json" \
	 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzaG9ydGVud29ybGQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiZXhwIjoxNjcxNjI1OTg3LCJ1c2VyIjp7ImlkIjoxMDEwLCJjaWYiOiJlYWUyZDc5NS0wYzZmLTQ2MWItYTZkNC1lYjRmYTUwOGI4YzkiLCJ1c2VybmFtZSI6InNob3J0ZW53b3JsZCIsImVtYWlsIjoic3VwcG9ydEBzaG9ydGVud29ybGQuY29tIiwiZnVsbE5hbWUiOiJI4buTbmcgTmh1bmciLCJsZXZlbCI6MCwibWFuYWdlciI6ZmFsc2UsImJhbmsiOmZhbHNlLCJ0b3RhbExvZ2luIjoxLCJ0b2RheUxvZ2luIjoxLCJsYXN0TG9naW5UaW1lIjpudWxsLCJsYXN0TG9naW5JcCI6bnVsbCwibGFzdExvZ2luRGV2aWNlIjpudWxsLCJsYXN0TG9naW5Mb2NhdGlvbiI6bnVsbCwibG9jYWxlIjoidmkifSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9VU0VSIl0sImp0aSI6IlB0R3ROd2hwcVMrSElLYnFoNEFhdlFkU1RPMD0iLCJjbGllbnRfaWQiOiJhcGlMaW5rIn0.B400MYwEdL5j9U4E3HGZ0SqQ6n38NwQvp7o2n-GROZyUZmEDPRQYDDa6v9AqVqbCdPuKbrWQv2QeU_PGHD5lcsx5RDvkHAPxhz8WNcAeYjgBC9uVYOQ8giMYotJ13b14jpUba5bdnoFB-ozvkqnnfZWStacYEDhbhbu8Udd2xtHp4CDwMEJDsV0UcOmCDw6MKAc4NFmKCXThXTi6FhxUlYS2YJ4WjXX94Gjiw5nnRRgeNSJQEAjkotTV3RPoi6VzQFL4hyp2zdzJxWtAKqTGEv2njBJG7CPN_4e71EJ5w6ovZ1OxTkHUBfugaQjoS4reZzJiBdUE2ONFfrfXT1Zc6A" \
	 -d '{"teamId":"6340e9c7a26da453b891b752","size":20,"page":0}'

                    
									
{
  "status": {
    "message": "Wow, successfully!",
    "code": 0,
    "timestamp": "2022-12-22T05:21:44+0000"
  },
  "teamTrackers": [
    {
      "id": "635a3f060fc80f6428c80735",
      "trackerId": "635a184a172e000047005863",
      "code": "UA-9999999988",
      "name": "My Google Analytics Pixel",
      "createdTime": "2022-10-27T08:19:18.148+0000"
    },
    {
      "id": "635a3e260fc80f6428c80734",
      "trackerId": "635a1844172e000047005862",
      "code": "121145523322155",
      "name": "My Facebook Pixel",
      "createdTime": "2022-10-27T08:15:34.837+0000"
    }
  ],
  "total": 2
}

To get pretty JSON response we can use format tool: https://format.asia/json-format

HTTP Status

`200`	Success
`401`	Unauthorized
`403`	Your account is locked or permission denied
`429`	Login too many failed
`500`	An unknown error

Json string will be sent, containing following data

`status => code: 0`	Success
`status => code: not equal 0`	Error
`status => message`	Error message
`status => timestamp`	The time server responses

Get link tracker list

This API will get link tracker list.

Required headers

`Content-Type`	[String, Required]. Value is: application/json
`Authorization`	[String, Required]. Value is: Bearer [access_token]

Possible parameters

`linkId`	[String, Required]. Get linkId from Get link list API or Create link API.
`size`	[Number, Optional]. The number of results each page, default 20 results.
`page`	[Number, Optional]. The page of results, default is 0. Start page is 0.

Examples

cURL Response

                    
									
curl -X POST https://api.shortenworld.com/v1/entity/link/tracker/list \
	 -H "Content-Type: application/json" \
	 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzaG9ydGVud29ybGQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiZXhwIjoxNjcxNjI1OTg3LCJ1c2VyIjp7ImlkIjoxMDEwLCJjaWYiOiJlYWUyZDc5NS0wYzZmLTQ2MWItYTZkNC1lYjRmYTUwOGI4YzkiLCJ1c2VybmFtZSI6InNob3J0ZW53b3JsZCIsImVtYWlsIjoic3VwcG9ydEBzaG9ydGVud29ybGQuY29tIiwiZnVsbE5hbWUiOiJI4buTbmcgTmh1bmciLCJsZXZlbCI6MCwibWFuYWdlciI6ZmFsc2UsImJhbmsiOmZhbHNlLCJ0b3RhbExvZ2luIjoxLCJ0b2RheUxvZ2luIjoxLCJsYXN0TG9naW5UaW1lIjpudWxsLCJsYXN0TG9naW5JcCI6bnVsbCwibGFzdExvZ2luRGV2aWNlIjpudWxsLCJsYXN0TG9naW5Mb2NhdGlvbiI6bnVsbCwibG9jYWxlIjoidmkifSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9VU0VSIl0sImp0aSI6IlB0R3ROd2hwcVMrSElLYnFoNEFhdlFkU1RPMD0iLCJjbGllbnRfaWQiOiJhcGlMaW5rIn0.B400MYwEdL5j9U4E3HGZ0SqQ6n38NwQvp7o2n-GROZyUZmEDPRQYDDa6v9AqVqbCdPuKbrWQv2QeU_PGHD5lcsx5RDvkHAPxhz8WNcAeYjgBC9uVYOQ8giMYotJ13b14jpUba5bdnoFB-ozvkqnnfZWStacYEDhbhbu8Udd2xtHp4CDwMEJDsV0UcOmCDw6MKAc4NFmKCXThXTi6FhxUlYS2YJ4WjXX94Gjiw5nnRRgeNSJQEAjkotTV3RPoi6VzQFL4hyp2zdzJxWtAKqTGEv2njBJG7CPN_4e71EJ5w6ovZ1OxTkHUBfugaQjoS4reZzJiBdUE2ONFfrfXT1Zc6A" \
	 -d '{"linkId":"63a3d2af450da672f48d90ff","size":20,"page":0}'

                    
									
{
  "status": {
    "message": "Wow, successfully!",
    "code": 0,
    "timestamp": "2022-12-22T05:49:11+0000"
  },
  "linkTracker": [
    {
      "id": "63a3ef78450da64a60b15f69",
      "trackerId": "635a184a172e000047005863",
      "code": "UA-8978698976",
      "createdTime": "2022-12-22T05:47:36.412+0000"
    },
    {
      "id": "63a3ef1c450da64a60b15f68",
      "trackerId": "635a1869172e000047005866",
      "code": "212121",
      "createdTime": "2022-12-22T05:46:04.277+0000"
    }
  ],
  "total": 2
}

To get pretty JSON response we can use format tool: https://format.asia/json-format

HTTP Status

`200`	Success
`401`	Unauthorized
`403`	Your account is locked or permission denied
`429`	Login too many failed
`500`	An unknown error

Json string will be sent, containing following data

`status => code: 0`	Success
`status => code: not equal 0`	Error
`status => message`	Error message
`status => timestamp`	The time server responses

Create link tracker

This API will create link tracker.

Required headers

`Content-Type`	[String, Required]. Value is: application/json
`Authorization`	[String, Required]. Value is: Bearer [access_token]

Possible parameters

`linkId`	[String, Required]. Get linkId from Get link list API or Create link API.
`type`	[String, Required]. If value is "1", we will create link tracker by copy from team tracker. If value is "0", we will create link tracker by adding new code of tracker provider directly (like Google pixel code...)
`teamTrackers`	[String array, Optional]. Required if `type` above is "1". If value is "all-trackers", we will create link trackers by copy all team trackers. Otherwise it will be the list of `teamTrackers => id` from Get team tracker list API
`code`	[String, Optional]. Required if `type` above is "0". The code of your tracker provider (like Google pixel code...)
`trackerId`	[String, Optional]. Required if `type` above is "0". Get trackerId from `trackers => id` at Get tracker list API

Examples

cURL Response

                    
									
curl -X POST https://api.shortenworld.com/v1/entity/link/create-tracker \
	 -H "Content-Type: application/json" \
	 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzaG9ydGVud29ybGQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiZXhwIjoxNjcxNjI1OTg3LCJ1c2VyIjp7ImlkIjoxMDEwLCJjaWYiOiJlYWUyZDc5NS0wYzZmLTQ2MWItYTZkNC1lYjRmYTUwOGI4YzkiLCJ1c2VybmFtZSI6InNob3J0ZW53b3JsZCIsImVtYWlsIjoic3VwcG9ydEBzaG9ydGVud29ybGQuY29tIiwiZnVsbE5hbWUiOiJI4buTbmcgTmh1bmciLCJsZXZlbCI6MCwibWFuYWdlciI6ZmFsc2UsImJhbmsiOmZhbHNlLCJ0b3RhbExvZ2luIjoxLCJ0b2RheUxvZ2luIjoxLCJsYXN0TG9naW5UaW1lIjpudWxsLCJsYXN0TG9naW5JcCI6bnVsbCwibGFzdExvZ2luRGV2aWNlIjpudWxsLCJsYXN0TG9naW5Mb2NhdGlvbiI6bnVsbCwibG9jYWxlIjoidmkifSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9VU0VSIl0sImp0aSI6IlB0R3ROd2hwcVMrSElLYnFoNEFhdlFkU1RPMD0iLCJjbGllbnRfaWQiOiJhcGlMaW5rIn0.B400MYwEdL5j9U4E3HGZ0SqQ6n38NwQvp7o2n-GROZyUZmEDPRQYDDa6v9AqVqbCdPuKbrWQv2QeU_PGHD5lcsx5RDvkHAPxhz8WNcAeYjgBC9uVYOQ8giMYotJ13b14jpUba5bdnoFB-ozvkqnnfZWStacYEDhbhbu8Udd2xtHp4CDwMEJDsV0UcOmCDw6MKAc4NFmKCXThXTi6FhxUlYS2YJ4WjXX94Gjiw5nnRRgeNSJQEAjkotTV3RPoi6VzQFL4hyp2zdzJxWtAKqTGEv2njBJG7CPN_4e71EJ5w6ovZ1OxTkHUBfugaQjoS4reZzJiBdUE2ONFfrfXT1Zc6A" \
	 -d '{"linkId":"63a3d2af450da672f48d90ff","type":"1","teamTrackers":["all-trackers"]}' 

curl -X POST https://api.shortenworld.com/v1/entity/link/create-tracker \
	 -H "Content-Type: application/json" \
	 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzaG9ydGVud29ybGQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiZXhwIjoxNjcxNjI1OTg3LCJ1c2VyIjp7ImlkIjoxMDEwLCJjaWYiOiJlYWUyZDc5NS0wYzZmLTQ2MWItYTZkNC1lYjRmYTUwOGI4YzkiLCJ1c2VybmFtZSI6InNob3J0ZW53b3JsZCIsImVtYWlsIjoic3VwcG9ydEBzaG9ydGVud29ybGQuY29tIiwiZnVsbE5hbWUiOiJI4buTbmcgTmh1bmciLCJsZXZlbCI6MCwibWFuYWdlciI6ZmFsc2UsImJhbmsiOmZhbHNlLCJ0b3RhbExvZ2luIjoxLCJ0b2RheUxvZ2luIjoxLCJsYXN0TG9naW5UaW1lIjpudWxsLCJsYXN0TG9naW5JcCI6bnVsbCwibGFzdExvZ2luRGV2aWNlIjpudWxsLCJsYXN0TG9naW5Mb2NhdGlvbiI6bnVsbCwibG9jYWxlIjoidmkifSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9VU0VSIl0sImp0aSI6IlB0R3ROd2hwcVMrSElLYnFoNEFhdlFkU1RPMD0iLCJjbGllbnRfaWQiOiJhcGlMaW5rIn0.B400MYwEdL5j9U4E3HGZ0SqQ6n38NwQvp7o2n-GROZyUZmEDPRQYDDa6v9AqVqbCdPuKbrWQv2QeU_PGHD5lcsx5RDvkHAPxhz8WNcAeYjgBC9uVYOQ8giMYotJ13b14jpUba5bdnoFB-ozvkqnnfZWStacYEDhbhbu8Udd2xtHp4CDwMEJDsV0UcOmCDw6MKAc4NFmKCXThXTi6FhxUlYS2YJ4WjXX94Gjiw5nnRRgeNSJQEAjkotTV3RPoi6VzQFL4hyp2zdzJxWtAKqTGEv2njBJG7CPN_4e71EJ5w6ovZ1OxTkHUBfugaQjoS4reZzJiBdUE2ONFfrfXT1Zc6A" \
	 -d '{"linkId":"63a3d2af450da672f48d90ff","type":"1","teamTrackers":["635a3f060fc80f6428c80735"]}' 
	 	 
curl -X POST https://api.shortenworld.com/v1/entity/link/create-tracker \
	 -H "Content-Type: application/json" \
	 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzaG9ydGVud29ybGQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiZXhwIjoxNjcxNjI1OTg3LCJ1c2VyIjp7ImlkIjoxMDEwLCJjaWYiOiJlYWUyZDc5NS0wYzZmLTQ2MWItYTZkNC1lYjRmYTUwOGI4YzkiLCJ1c2VybmFtZSI6InNob3J0ZW53b3JsZCIsImVtYWlsIjoic3VwcG9ydEBzaG9ydGVud29ybGQuY29tIiwiZnVsbE5hbWUiOiJI4buTbmcgTmh1bmciLCJsZXZlbCI6MCwibWFuYWdlciI6ZmFsc2UsImJhbmsiOmZhbHNlLCJ0b3RhbExvZ2luIjoxLCJ0b2RheUxvZ2luIjoxLCJsYXN0TG9naW5UaW1lIjpudWxsLCJsYXN0TG9naW5JcCI6bnVsbCwibGFzdExvZ2luRGV2aWNlIjpudWxsLCJsYXN0TG9naW5Mb2NhdGlvbiI6bnVsbCwibG9jYWxlIjoidmkifSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9VU0VSIl0sImp0aSI6IlB0R3ROd2hwcVMrSElLYnFoNEFhdlFkU1RPMD0iLCJjbGllbnRfaWQiOiJhcGlMaW5rIn0.B400MYwEdL5j9U4E3HGZ0SqQ6n38NwQvp7o2n-GROZyUZmEDPRQYDDa6v9AqVqbCdPuKbrWQv2QeU_PGHD5lcsx5RDvkHAPxhz8WNcAeYjgBC9uVYOQ8giMYotJ13b14jpUba5bdnoFB-ozvkqnnfZWStacYEDhbhbu8Udd2xtHp4CDwMEJDsV0UcOmCDw6MKAc4NFmKCXThXTi6FhxUlYS2YJ4WjXX94Gjiw5nnRRgeNSJQEAjkotTV3RPoi6VzQFL4hyp2zdzJxWtAKqTGEv2njBJG7CPN_4e71EJ5w6ovZ1OxTkHUBfugaQjoS4reZzJiBdUE2ONFfrfXT1Zc6A" \
	 -d '{"linkId":"63a3d2af450da672f48d90ff","type":"0","code":"UA-8978698976","trackerId":"635a184a172e000047005863"}'

                    
									
{
  "status": {
    "message": "Wow, successfully!",
    "code": 0,
    "timestamp": "2022-12-22T05:21:50+0000"
  }
}

To get pretty JSON response we can use format tool: https://format.asia/json-format

HTTP Status

`200`	Success
`401`	Unauthorized
`403`	Your account is locked or permission denied
`429`	Login too many failed
`500`	An unknown error

Json string will be sent, containing following data

`status => code: 0`	Success
`status => code: not equal 0`	Error
`status => message`	Error message
`status => timestamp`	The time server responses

Delete link tracker

This API will delete link tracker.

Required headers

`Content-Type`	[String, Required]. Value is: application/json
`Authorization`	[String, Required]. Value is: Bearer [access_token]

Possible parameters

linkTrackerId [String, Required]. Get linkTrackerId from Get link tracker list API.

Examples

cURL Response

                    
									
curl -X POST https://api.shortenworld.com/v1/entity/link/delete-tracker \
	 -H "Content-Type: application/json" \
	 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzaG9ydGVud29ybGQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiZXhwIjoxNjcxNjI1OTg3LCJ1c2VyIjp7ImlkIjoxMDEwLCJjaWYiOiJlYWUyZDc5NS0wYzZmLTQ2MWItYTZkNC1lYjRmYTUwOGI4YzkiLCJ1c2VybmFtZSI6InNob3J0ZW53b3JsZCIsImVtYWlsIjoic3VwcG9ydEBzaG9ydGVud29ybGQuY29tIiwiZnVsbE5hbWUiOiJI4buTbmcgTmh1bmciLCJsZXZlbCI6MCwibWFuYWdlciI6ZmFsc2UsImJhbmsiOmZhbHNlLCJ0b3RhbExvZ2luIjoxLCJ0b2RheUxvZ2luIjoxLCJsYXN0TG9naW5UaW1lIjpudWxsLCJsYXN0TG9naW5JcCI6bnVsbCwibGFzdExvZ2luRGV2aWNlIjpudWxsLCJsYXN0TG9naW5Mb2NhdGlvbiI6bnVsbCwibG9jYWxlIjoidmkifSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9VU0VSIl0sImp0aSI6IlB0R3ROd2hwcVMrSElLYnFoNEFhdlFkU1RPMD0iLCJjbGllbnRfaWQiOiJhcGlMaW5rIn0.B400MYwEdL5j9U4E3HGZ0SqQ6n38NwQvp7o2n-GROZyUZmEDPRQYDDa6v9AqVqbCdPuKbrWQv2QeU_PGHD5lcsx5RDvkHAPxhz8WNcAeYjgBC9uVYOQ8giMYotJ13b14jpUba5bdnoFB-ozvkqnnfZWStacYEDhbhbu8Udd2xtHp4CDwMEJDsV0UcOmCDw6MKAc4NFmKCXThXTi6FhxUlYS2YJ4WjXX94Gjiw5nnRRgeNSJQEAjkotTV3RPoi6VzQFL4hyp2zdzJxWtAKqTGEv2njBJG7CPN_4e71EJ5w6ovZ1OxTkHUBfugaQjoS4reZzJiBdUE2ONFfrfXT1Zc6A" \
	 -d '{"linkTrackerId":"63a3ef78450da64a60b15f69"}'

                    
									
{
  "status": {
    "message": "Wow, successfully!",
    "code": 0,
    "timestamp": "2022-12-22T05:22:50+0000"
  }
}

To get pretty JSON response we can use format tool: https://format.asia/json-format

HTTP Status

`200`	Success
`401`	Unauthorized
`403`	Your account is locked or permission denied
`429`	Login too many failed
`500`	An unknown error

Json string will be sent, containing following data

`status => code: 0`	Success
`status => code: not equal 0`	Error
`status => message`	Error message
`status => timestamp`	The time server responses

Link A/B/C/D/E/F... testing

This API will set alternate redirect URLs to see which one is the best for customers

Required headers

`Content-Type`	[String, Required]. Value is: application/json
`Authorization`	[String, Required]. Value is: Bearer [access_token]

Possible parameters

`linkId`	[String, Required]. Get linkId from Get link list API or Create link API.
`testing`	[Object Array, Required]. Array of object containing: `link` and `percentage`. `link` (String) is new destination and `percentage` (Number: 1-100 percent) is the rate to redirect. Each object in array order is equivalent to A,B,C,D... testing

Examples

cURL Response

                    
									
curl -X POST https://api.shortenworld.com/v1/entity/link/testing \
	 -H "Content-Type: application/json" \
	 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzaG9ydGVud29ybGQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiZXhwIjoxNjcxNjI1OTg3LCJ1c2VyIjp7ImlkIjoxMDEwLCJjaWYiOiJlYWUyZDc5NS0wYzZmLTQ2MWItYTZkNC1lYjRmYTUwOGI4YzkiLCJ1c2VybmFtZSI6InNob3J0ZW53b3JsZCIsImVtYWlsIjoic3VwcG9ydEBzaG9ydGVud29ybGQuY29tIiwiZnVsbE5hbWUiOiJI4buTbmcgTmh1bmciLCJsZXZlbCI6MCwibWFuYWdlciI6ZmFsc2UsImJhbmsiOmZhbHNlLCJ0b3RhbExvZ2luIjoxLCJ0b2RheUxvZ2luIjoxLCJsYXN0TG9naW5UaW1lIjpudWxsLCJsYXN0TG9naW5JcCI6bnVsbCwibGFzdExvZ2luRGV2aWNlIjpudWxsLCJsYXN0TG9naW5Mb2NhdGlvbiI6bnVsbCwibG9jYWxlIjoidmkifSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9VU0VSIl0sImp0aSI6IlB0R3ROd2hwcVMrSElLYnFoNEFhdlFkU1RPMD0iLCJjbGllbnRfaWQiOiJhcGlMaW5rIn0.B400MYwEdL5j9U4E3HGZ0SqQ6n38NwQvp7o2n-GROZyUZmEDPRQYDDa6v9AqVqbCdPuKbrWQv2QeU_PGHD5lcsx5RDvkHAPxhz8WNcAeYjgBC9uVYOQ8giMYotJ13b14jpUba5bdnoFB-ozvkqnnfZWStacYEDhbhbu8Udd2xtHp4CDwMEJDsV0UcOmCDw6MKAc4NFmKCXThXTi6FhxUlYS2YJ4WjXX94Gjiw5nnRRgeNSJQEAjkotTV3RPoi6VzQFL4hyp2zdzJxWtAKqTGEv2njBJG7CPN_4e71EJ5w6ovZ1OxTkHUBfugaQjoS4reZzJiBdUE2ONFfrfXT1Zc6A" \
	 -d '{"linkId":"63a3d2af450da672f48d90ff","testing":[{"link":"https://format.asia/json-formats","percentage":"20"},{"link":"https://format.asia/sha2-hash-generator","percentage":"20"},{"link":"https://format.asia/sha3-224-hash-generator","percentage":"20"},{"link":"https://format.asia/case-converter","percentage":"20"},{"link":"https://format.asia/text-to-rot13-converter","percentage":"20"}]}'

                    
									
{
  "status": {
    "message": "Wow, successfully!",
    "code": 0,
    "timestamp": "2022-12-22T05:28:50+0000"
  }
}

To get pretty JSON response we can use format tool: https://format.asia/json-format

HTTP Status

`200`	Success
`401`	Unauthorized
`403`	Your account is locked or permission denied
`429`	Login too many failed
`500`	An unknown error

Json string will be sent, containing following data

`status => code: 0`	Success
`status => code: not equal 0`	Error
`status => message`	Error message
`status => timestamp`	The time server responses

Link analytics

This API will get analytics of the link follow by time filters

Required headers

`Content-Type`	[String, Required]. Value is: application/json
`Authorization`	[String, Required]. Value is: Bearer [access_token]

Possible parameters

`linkId`	[String, Required]. Get linkId from Get link list API or Create link API.
`startTime`	[String, Optional]. Start time to filter, format: dd/MM/yyyy. If not specified, it will filter in last 30 days
`endTime`	[String, Optional]. End time to filter, format: dd/MM/yyyy. If not specified, it will filter in last 30 days

Examples

cURL Response

                    
									
curl -X POST https://api.shortenworld.com/v1/entity/link/analytics \
	 -H "Content-Type: application/json" \
	 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJzaG9ydGVud29ybGQiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiZXhwIjoxNjcxNjI1OTg3LCJ1c2VyIjp7ImlkIjoxMDEwLCJjaWYiOiJlYWUyZDc5NS0wYzZmLTQ2MWItYTZkNC1lYjRmYTUwOGI4YzkiLCJ1c2VybmFtZSI6InNob3J0ZW53b3JsZCIsImVtYWlsIjoic3VwcG9ydEBzaG9ydGVud29ybGQuY29tIiwiZnVsbE5hbWUiOiJI4buTbmcgTmh1bmciLCJsZXZlbCI6MCwibWFuYWdlciI6ZmFsc2UsImJhbmsiOmZhbHNlLCJ0b3RhbExvZ2luIjoxLCJ0b2RheUxvZ2luIjoxLCJsYXN0TG9naW5UaW1lIjpudWxsLCJsYXN0TG9naW5JcCI6bnVsbCwibGFzdExvZ2luRGV2aWNlIjpudWxsLCJsYXN0TG9naW5Mb2NhdGlvbiI6bnVsbCwibG9jYWxlIjoidmkifSwiYXV0aG9yaXRpZXMiOlsiUk9MRV9VU0VSIl0sImp0aSI6IlB0R3ROd2hwcVMrSElLYnFoNEFhdlFkU1RPMD0iLCJjbGllbnRfaWQiOiJhcGlMaW5rIn0.B400MYwEdL5j9U4E3HGZ0SqQ6n38NwQvp7o2n-GROZyUZmEDPRQYDDa6v9AqVqbCdPuKbrWQv2QeU_PGHD5lcsx5RDvkHAPxhz8WNcAeYjgBC9uVYOQ8giMYotJ13b14jpUba5bdnoFB-ozvkqnnfZWStacYEDhbhbu8Udd2xtHp4CDwMEJDsV0UcOmCDw6MKAc4NFmKCXThXTi6FhxUlYS2YJ4WjXX94Gjiw5nnRRgeNSJQEAjkotTV3RPoi6VzQFL4hyp2zdzJxWtAKqTGEv2njBJG7CPN_4e71EJ5w6ovZ1OxTkHUBfugaQjoS4reZzJiBdUE2ONFfrfXT1Zc6A" \
	 -d '{"linkId":"63a3d2af450da672f48d90ff","startTime":"01/01/2021","endTime":"01/01/2023"}'

                    
									
{
  "status": {
    "message": "Wow, successfully!",
    "code": 0,
    "timestamp": "2022-12-22T08:08:51+0000"
  },
  "metricsMap": {
    "1": [
      {
        "name": "2022-12-05",
        "key": "1670198400000",
        "count": 5,
        "child": [
          {
            "name": "Direct",
            "key": "1",
            "count": 5,
            "child": null
          }
        ]
      },
      {
        "name": "2022-12-06",
        "key": "1670284800000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-07",
        "key": "1670371200000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-08",
        "key": "1670457600000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-09",
        "key": "1670544000000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-10",
        "key": "1670630400000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-11",
        "key": "1670716800000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-12",
        "key": "1670803200000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-13",
        "key": "1670889600000",
        "count": 1,
        "child": [
          {
            "name": "Direct",
            "key": "1",
            "count": 1,
            "child": null
          }
        ]
      },
      {
        "name": "2022-12-14",
        "key": "1670976000000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-15",
        "key": "1671062400000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-16",
        "key": "1671148800000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-17",
        "key": "1671235200000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-18",
        "key": "1671321600000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-19",
        "key": "1671408000000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-20",
        "key": "1671494400000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-21",
        "key": "1671580800000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-22",
        "key": "1671667200000",
        "count": 2,
        "child": [
          {
            "name": "Direct",
            "key": "1",
            "count": 2,
            "child": null
          }
        ]
      }
    ],
    "2": [
      {
        "name": "Desktop",
        "key": "1",
        "count": 5,
        "child": null
      },
      {
        "name": "Unknown",
        "key": "4",
        "count": 3,
        "child": null
      }
    ],
    "3": [
      {
        "name": "Win10",
        "key": "1",
        "count": 5,
        "child": [
          {
            "name": "10.0",
            "key": "1",
            "count": 5,
            "child": null
          }
        ]
      },
      {
        "name": "Unknown",
        "key": "7",
        "count": 3,
        "child": [
          {
            "name": "Unknown",
            "key": "3",
            "count": 3,
            "child": null
          }
        ]
      }
    ],
    "4": [
      {
        "name": "Chrome",
        "key": "2",
        "count": 5,
        "child": [
          {
            "name": "0",
            "key": "7",
            "count": 4,
            "child": null
          },
          {
            "name": "107",
            "key": "3",
            "count": 1,
            "child": null
          }
        ]
      },
      {
        "name": "Google Bot",
        "key": "8",
        "count": 3,
        "child": [
          {
            "name": "2",
            "key": "8",
            "count": 3,
            "child": null
          }
        ]
      }
    ],
    "5": [
      {
        "name": "Unknown",
        "key": "1",
        "count": 8,
        "child": [
          {
            "name": "Windows Desktop",
            "key": "1",
            "count": 5,
            "child": null
          },
          {
            "name": "Unknown",
            "key": "8",
            "count": 3,
            "child": null
          }
        ]
      }
    ],
    "6": [
      {
        "name": "en",
        "key": "1",
        "count": 8,
        "child": null
      }
    ],
    "7": [
      {
        "name": "Local",
        "key": "1",
        "count": 8,
        "child": null
      }
    ],
    "8": [
      {
        "name": "Google Bot",
        "key": "1",
        "count": 3,
        "child": null
      }
    ],
    "9": [
      {
        "name": "2022-12-05",
        "key": "1670198400000",
        "count": 5,
        "child": null
      },
      {
        "name": "2022-12-06",
        "key": "1670284800000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-07",
        "key": "1670371200000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-08",
        "key": "1670457600000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-09",
        "key": "1670544000000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-10",
        "key": "1670630400000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-11",
        "key": "1670716800000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-12",
        "key": "1670803200000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-13",
        "key": "1670889600000",
        "count": 1,
        "child": null
      },
      {
        "name": "2022-12-14",
        "key": "1670976000000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-15",
        "key": "1671062400000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-16",
        "key": "1671148800000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-17",
        "key": "1671235200000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-18",
        "key": "1671321600000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-19",
        "key": "1671408000000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-20",
        "key": "1671494400000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-21",
        "key": "1671580800000",
        "count": 0,
        "child": null
      },
      {
        "name": "2022-12-22",
        "key": "1671667200000",
        "count": 2,
        "child": null
      }
    ],
    "10": [
      {
        "name": "Direct",
        "key": "1",
        "count": 8,
        "child": null
      }
    ]
  }
}

To get pretty JSON response we can use format tool: https://format.asia/json-format

HTTP Status

`200`	Success
`401`	Unauthorized
`403`	Your account is locked or permission denied
`429`	Login too many failed
`500`	An unknown error

Json string will be sent, containing following data

`status => code: 0`	Success
`status => code: not equal 0`	Error
`status => message`	Error message
`status => timestamp`	The time server responses

If HTTP Status is 200 and status=>code is equal to 0, then

`metricsMap => 1`	Source of clicks by date
`metricsMap => 2`	Devices clicks
`metricsMap => 3`	System (OS) clicks
`metricsMap => 4`	Browsers clicks
`metricsMap => 5`	Brand clicks
`metricsMap => 6`	Languages clicks
`metricsMap => 7`	Geo Location clicks
`metricsMap => 8`	Bots clicks. Not available on free plan
`metricsMap => 9`	Total clicks by date

API limits

API limits per account depending on subscription plan
Check API limits

API document

Endpoints

All API list

Get token

Required headers

Possible parameters

Examples

HTTP Status

Json string will be sent, containing following data

If HTTP Status is 200 and status => code is equal to 0, then

Refresh token

Required headers

Possible parameters

Examples

HTTP Status

Json string will be sent, containing following data

If HTTP Status is 200 and status=>code is equal to 0, then

Revoke token

Required headers

Possible parameters

Examples

HTTP Status

Json string will be sent, containing following data

Get team list

Required headers

Possible parameters

Examples

HTTP Status

Json string will be sent, containing following data

Get campaign list

Required headers

Possible parameters

Examples

HTTP Status

Json string will be sent, containing following data

Get domain subscriptions

Required headers

Possible parameters

Examples

HTTP Status

Json string will be sent, containing following data

Get link list

Required headers

Possible parameters

Examples

HTTP Status

Json string will be sent, containing following data

Create link

Required headers

Possible parameters

Examples

HTTP Status

Json string will be sent, containing following data

Update link

Required headers

Possible parameters

Examples

HTTP Status

Json string will be sent, containing following data

Delete link

Required headers

Possible parameters

Examples

HTTP Status

Json string will be sent, containing following data

Redirect link

Required headers

Possible parameters

Examples

HTTP Status

Json string will be sent, containing following data

Redirect mobile link

Required headers

Possible parameters

Examples

HTTP Status

Json string will be sent, containing following data

Expiration link

Required headers

Possible parameters

If HTTP Status is 200 and `status => code` is equal to 0, then