Retreive a Bitsy Link
Retrieve a Bitsy Link by ID
curl --request GET \
--url https://api.bsy.sh/v1/link \
--header 'Authorization: Bearer <token>'{
"status": "success",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"long_url": "<string>",
"title": "<string>",
"favicon": "<string>",
"custom_link": "<string>",
"tags": [
"<string>"
],
"has_utm": true,
"has_opengraph": true,
"has_android_targeting": true,
"android_target_url": "<string>",
"has_ios_targeting": true,
"ios_target_url": "<string>",
"has_windows_targeting": true,
"windows_target_url": "<string>",
"has_linux_targeting": true,
"linux_target_url": "<string>",
"has_geo_targeting": true,
"has_cloaking": true,
"has_password": true,
"password_logo": "<string>",
"has_expiration": true,
"expiration": "2023-11-07T05:31:56Z",
"expiration_clicks": "<string>",
"is_expired": true,
"is_clicked": true,
"last_clicked": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"bitsy_url": "<string>",
"custom_url": "<string>",
"utm": {
"utm_source": "<string>",
"utm_medium": "<string>",
"utm_campaign": "<string>",
"utm_term": "<string>",
"utm_content": "<string>"
},
"opengraph": {
"meta_title": "<string>",
"meta_description": "<string>",
"meta_image": "<string>"
},
"geo_targets": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"target_url": "<string>",
"country": {
"iso2": "<string>",
"name": "<string>"
}
}
],
"shareable_analytics": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"share_url": "<string>",
"has_password": true
}
]
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The unique identifier for the Bitsy Link.
Response
success The ID of the Bitsy Link.
The long URL that the shortened link will redirect to.
Title of the link, up to 150 characters.
150URL of the favicon for the link.
Custom slug for the link, between 3 and 50 characters.
3 - 50Array of tags associated with the link.
Indicates if UTM parameters are used.
Indicates if OpenGraph metadata is included.
Indicates if there is a target URL for Android.
Target URL for Android devices.
Indicates if there is a target URL for iOS.
Target URL for iOS devices.
Indicates if there is a target URL for Windows.
Target URL for Windows devices.
Indicates if there is a target URL for Linux.
Target URL for Linux devices.
Indicates if geo-targeting is used.
Indicates if cloaking is enabled.
Indicates if a password is required to access the link.
URL of the logo to display on the password prompt.
Indicates if the link has an expiration date or expiration clicks.
Expiration date for the link in ISO 8601 format.
Maximum number of clicks before the link expires.
Indicates whether the shortened URL has expired and is no longer valid.
Indicates whether the shortened URL has been clicked at least once.
The timestamp of the last time the shortened URL was clicked.
The timestamp indicating when the Bitsy Link was created.
The shortened URL generated for the Bitsy Link.
The custom URL provided for the shortened link, if applicable.
UTM source for tracking.
200UTM medium for tracking.
200UTM campaign for tracking.
200UTM term for paid search.
200UTM content for differentiating ads.
200Array of geo-targeting rules.
The ID of the geo target.
Target URL for the specified country.
The ID of the shareable analytics.
The date indicating the start of the analytics.
The date indicating the end of the analytics.
The timestamp indicating when the shareable link was created.
A URL that can be shared to allow others to access the Bitsy analytics.
Indicates if a password is required to access the link.
Was this page helpful?
curl --request GET \
--url https://api.bsy.sh/v1/link \
--header 'Authorization: Bearer <token>'{
"status": "success",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"long_url": "<string>",
"title": "<string>",
"favicon": "<string>",
"custom_link": "<string>",
"tags": [
"<string>"
],
"has_utm": true,
"has_opengraph": true,
"has_android_targeting": true,
"android_target_url": "<string>",
"has_ios_targeting": true,
"ios_target_url": "<string>",
"has_windows_targeting": true,
"windows_target_url": "<string>",
"has_linux_targeting": true,
"linux_target_url": "<string>",
"has_geo_targeting": true,
"has_cloaking": true,
"has_password": true,
"password_logo": "<string>",
"has_expiration": true,
"expiration": "2023-11-07T05:31:56Z",
"expiration_clicks": "<string>",
"is_expired": true,
"is_clicked": true,
"last_clicked": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"bitsy_url": "<string>",
"custom_url": "<string>",
"utm": {
"utm_source": "<string>",
"utm_medium": "<string>",
"utm_campaign": "<string>",
"utm_term": "<string>",
"utm_content": "<string>"
},
"opengraph": {
"meta_title": "<string>",
"meta_description": "<string>",
"meta_image": "<string>"
},
"geo_targets": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"target_url": "<string>",
"country": {
"iso2": "<string>",
"name": "<string>"
}
}
],
"shareable_analytics": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"share_url": "<string>",
"has_password": true
}
]
}
}