Links

Notes
Expert level
The API key should be sent as a Bearer token in the Authorization header of the request. Get your API key.
List

API endpoint:

GET 
https://short.siteup24.com/api/v1/links

Request example: 

curl --location --request GET 'https://short.siteup24.com/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Description
search
optional string
Search query.
search_by
optional string
Search by. Possible values are: title for Title, alias for Alias, url for URL. Defaults to: title.
status
optional integer
Status. Possible values are: 0 for All, 1 for Active, 2 for Expired, 3 for Disabled. Defaults to: 0.
space_id
optional integer
Space ID.
domain_id
optional integer
Domain ID.
pixel_id
optional integer
Pixel ID.
sort_by
optional string
Sort by. Possible values are: id for Date created, clicks for Clicks, title for Title, alias for Alias, url for URL. Defaults to: id.
sort
optional string
Sort. Possible values are: desc for Descending, asc for Ascending. Defaults to: desc.
per_page
optional integer
Results per page. Possible values are: 10, 25, 50, 100. Defaults to: 10.
Show

API endpoint:

GET 
https://short.siteup24.com/api/v1/links/{id}

Request example: 

curl --location --request GET 'https://short.siteup24.com/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Store

API endpoint:

POST 
https://short.siteup24.com/api/v1/links

Request example: 

curl --location --request POST 'https://short.siteup24.com/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}' \
--data-urlencode 'domain={id}'
Parameter
Type
Description
url
required string
Destination URL.
domain_id
required integer
Domain ID.
alias
optional string
Alias.
space_id
optional integer
Space ID.
pixel_ids[]
optional array
Pixel IDs.
redirect_password
optional string
Redirect password.
sensitive_content
optional integer
Sensitive content. Possible values are: 0 for No, 1 for Yes. Defaults to: 0.
privacy
optional integer
Stats privacy. Possible values are: 0 for Public, 1 for Private, 2 for Password. Defaults to: 0.
password
optional string
Stats password. Only works with privacy field set to 2.
active_period_start_at
optional string
DActive period starting date in Y-m-d H:i format.
active_period_end_at
optional string
Active period ending date in Y-m-d H:i format.
clicks_limit
optional integer
Clicks limit.
expiration_url
optional string
Expiration URL.
targets_type
optional string
Targeting. Possible values are: continents for Continents, countries for Countries, operating_systems for Operating systems, browsers for Browsers, languages for Languages, devices for Devices, rotations for Rotations.
targets[index][key]
optional string
For targets_type=country, the value must be in ISO 3166-1 alpha-2 format.
For targets_type=operating_systems, the possible values are iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
For targets_type=browsers, the possible values are: Chrome, Chromium, Firefox, Firefox Mobile, Edge, Internet Explorer, Mobile Internet Explorer, Vivaldi, Brave, Safari, Opera, Opera Mini, Opera Mobile, Opera Touch, Yandex Browser, UC Browser, Samsung Internet, QQ Browser, BlackBerry Browser, Maxtho.
For targets_type=devices, the possible values are: Desktop, Mobile, Tablet, Watch, Television.
For targets_type=languages, the value must be in ISO 639-1 alpha-2 format.
For targets_type=continents, the possible values are: AF for Africa, AN for Antarctica, AS for Asia, EU for Europe, NA for North America, OC for Oceania, SA for South America.
targets[index][value]
optional string
Destination URL.
Update

API endpoint:

PUT PATCH 
https://short.siteup24.com/api/v1/links/{id}

Request example: 

curl --location --request PUT 'https://short.siteup24.com/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parameter
Type
Description
url
optional string
Destination URL.
alias
optional string
Alias.
space_id
optional integer
Space ID.
pixel_ids[]
optional array
Pixel IDs.
redirect_password
optional string
Redirect password.
sensitive_content
optional integer
Sensitive content. Possible values are: 0 for No, 1 for Yes.
privacy
optional integer
Stats privacy. Possible values are: 0 for Public, 1 for Private, 2 for Password.
password
optional string
Stats password. Only works with privacy field set to 2.
active_period_start_at
optional string
DActive period starting date in Y-m-d H:i format.
active_period_end_at
optional string
Active period ending date in Y-m-d H:i format.
clicks_limit
optional integer
Clicks limit.
expiration_url
optional string
Expiration URL.
targets_type
optional string
Targeting. Possible values are: continents for Continents, countries for Countries, operating_systems for Operating systems, browsers for Browsers, languages for Languages, devices for Devices, rotations for Rotations.
targets[index][key]
optional string
For targets_type=country, the value must be in ISO 3166-1 alpha-2 format.
For targets_type=operating_systems, the possible values are iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
For targets_type=browsers, the possible values are: Chrome, Chromium, Firefox, Firefox Mobile, Edge, Internet Explorer, Mobile Internet Explorer, Vivaldi, Brave, Safari, Opera, Opera Mini, Opera Mobile, Opera Touch, Yandex Browser, UC Browser, Samsung Internet, QQ Browser, BlackBerry Browser, Maxtho.
For targets_type=devices, the possible values are: Desktop, Mobile, Tablet, Watch, Television.
For targets_type=languages, the value must be in ISO 639-1 alpha-2 format.
For targets_type=continents, the possible values are: AF for Africa, AN for Antarctica, AS for Asia, EU for Europe, NA for North America, OC for Oceania, SA for South America.
targets[index][value]
optional string
Destination URL.
Delete

API endpoint:

DELETE 
https://short.siteup24.com/api/v1/links/{id}

Request example: 

curl --location --request DELETE 'https://short.siteup24.com/api/v1/links/{id}' \
--header 'Authorization: Bearer {api_key}'