Retrieve a Bitsy Link - Bitsy Documentation

cURL

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
      }
    ]
  }
}

GET

link

cURL

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

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

string<uuid>

required

The unique identifier for the Bitsy Link.

Response

Details of the requested Bitsy Link

status

enum<string>

required

Available options:

success

data

object

required

Show child attributes

data.id

string<uuid>

The ID of the Bitsy Link.

data.long_url

string<uri>

The long URL that the shortened link will redirect to.

data.title

string

Title of the link, up to 150 characters.

Maximum string length: 150

data.favicon

string

URL of the favicon for the link.

data.custom_link

string

Custom slug for the link, between 3 and 50 characters.

Required string length: 3 - 50

data.tags

string[]

Array of tags associated with the link.

Minimum string length: 1

data.has_utm

boolean

Indicates if UTM parameters are used.

data.has_opengraph

boolean

Indicates if OpenGraph metadata is included.

data.has_android_targeting

boolean

Indicates if there is a target URL for Android.

data.android_target_url

string

Target URL for Android devices.

data.has_ios_targeting

boolean

Indicates if there is a target URL for iOS.

data.ios_target_url

string

Target URL for iOS devices.

data.has_windows_targeting

boolean

Indicates if there is a target URL for Windows.

data.windows_target_url

string

Target URL for Windows devices.

data.has_linux_targeting

boolean

Indicates if there is a target URL for Linux.

data.linux_target_url

string

Target URL for Linux devices.

data.has_geo_targeting

boolean

Indicates if geo-targeting is used.

data.has_cloaking

boolean

Indicates if cloaking is enabled.

data.has_password

boolean

Indicates if a password is required to access the link.

data.password_logo

string

URL of the logo to display on the password prompt.

data.has_expiration

boolean

Indicates if the link has an expiration date or expiration clicks.

data.expiration

string<date-time>

Expiration date for the link in ISO 8601 format.

data.expiration_clicks

string

Maximum number of clicks before the link expires.

data.is_expired

boolean

Indicates whether the shortened URL has expired and is no longer valid.

data.is_clicked

boolean

Indicates whether the shortened URL has been clicked at least once.

data.last_clicked

string<date-time>

The timestamp of the last time the shortened URL was clicked.

data.created_at

string<date-time>

The timestamp indicating when the Bitsy Link was created.

data.bitsy_url

string<uri>

The shortened URL generated for the Bitsy Link.

data.custom_url

string<uri>

The custom URL provided for the shortened link, if applicable.

data.utm

object

Show child attributes

data.utm.utm_source

string

UTM source for tracking.

Maximum string length: 200

data.utm.utm_medium

string

UTM medium for tracking.

Maximum string length: 200

data.utm.utm_campaign

string

UTM campaign for tracking.

Maximum string length: 200

data.utm.utm_term

string

UTM term for paid search.

Maximum string length: 200

data.utm.utm_content

string

UTM content for differentiating ads.

Maximum string length: 200

data.opengraph

object

Show child attributes

data.opengraph.meta_title

string

Meta title for the link, up to 150 characters.

Maximum string length: 150

data.opengraph.meta_description

string

Meta description for the link, up to 250 characters.

Maximum string length: 250

data.opengraph.meta_image

string

URL of the image to use for the link's metadata.

data.geo_targets

object[]

Array of geo-targeting rules.

Show child attributes

data.geo_targets.id

string<uuid>

The ID of the geo target.

data.geo_targets.target_url

string<uri>

Target URL for the specified country.

data.geo_targets.country

object

Show child attributes

data.geo_targets.country.iso2

string

Two-letter country code (ISO 3166-1 alpha-2).

data.geo_targets.country.name

string

Name of country with flag emoji.

data.shareable_analytics

object[]

Show child attributes

data.shareable_analytics.id

string<uuid>

The ID of the shareable analytics.

data.shareable_analytics.start_date

string<date>

The date indicating the start of the analytics.

data.shareable_analytics.end_date

string<date>

The date indicating the end of the analytics.

data.shareable_analytics.created_at

string<date-time>

The timestamp indicating when the shareable link was created.

A URL that can be shared to allow others to access the Bitsy analytics.

data.shareable_analytics.has_password

boolean

Indicates if a password is required to access the link.

Create Bitsy Link Retrieve all Bitsy Links

⌘I

API Documentation

Bitsy Link

Authorizations

Query Parameters

Response