Retrieve a Bitsy Link Analytics - Bitsy Documentation

cURL

curl --request GET \
  --url https://api.bsy.sh/v1/link/stats \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "data": {
    "timeframe": "<string>",
    "total_count": 123,
    "unique_count": 123,
    "stats": {
      "country": [
        {
          "name": "<string>",
          "total_count": 123,
          "unique_count": 123
        }
      ],
      "region": [
        {
          "name": "<string>",
          "total_count": 123,
          "unique_count": 123
        }
      ],
      "city": [
        {
          "name": "<string>",
          "total_count": 123,
          "unique_count": 123
        }
      ],
      "os_name": [
        {
          "name": "<string>",
          "total_count": 123,
          "unique_count": 123
        }
      ],
      "device_type": [
        {
          "name": "<string>",
          "total_count": 123,
          "unique_count": 123
        }
      ],
      "device_brand": [
        {
          "name": "<string>",
          "total_count": 123,
          "unique_count": 123
        }
      ],
      "device_model": [
        {
          "name": "<string>",
          "total_count": 123,
          "unique_count": 123
        }
      ],
      "client_name": [
        {
          "name": "<string>",
          "total_count": 123,
          "unique_count": 123
        }
      ],
      "timezone": [
        {
          "name": "<string>",
          "total_count": 123,
          "unique_count": 123
        }
      ],
      "language": [
        {
          "name": "<string>",
          "total_count": 123,
          "unique_count": 123
        }
      ],
      "referrer": [
        {
          "name": "<string>",
          "total_count": 123,
          "unique_count": 123
        }
      ],
      "interval": {
        "hour": [
          {
            "date": "<string>",
            "total_count": 123,
            "unique_count": 123
          }
        ],
        "day": [
          {
            "date": "<string>",
            "total_count": 123,
            "unique_count": 123
          }
        ],
        "week": [
          {
            "date": "<string>",
            "total_count": 123,
            "unique_count": 123
          }
        ],
        "month": [
          {
            "date": "<string>",
            "total_count": 123,
            "unique_count": 123
          }
        ],
        "year": [
          {
            "date": "<string>",
            "total_count": 123,
            "unique_count": 123
          }
        ]
      }
    }
  }
}

GET

link

stats

cURL

curl --request GET \
  --url https://api.bsy.sh/v1/link/stats \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "data": {
    "timeframe": "<string>",
    "total_count": 123,
    "unique_count": 123,
    "stats": {
      "country": [
        {
          "name": "<string>",
          "total_count": 123,
          "unique_count": 123
        }
      ],
      "region": [
        {
          "name": "<string>",
          "total_count": 123,
          "unique_count": 123
        }
      ],
      "city": [
        {
          "name": "<string>",
          "total_count": 123,
          "unique_count": 123
        }
      ],
      "os_name": [
        {
          "name": "<string>",
          "total_count": 123,
          "unique_count": 123
        }
      ],
      "device_type": [
        {
          "name": "<string>",
          "total_count": 123,
          "unique_count": 123
        }
      ],
      "device_brand": [
        {
          "name": "<string>",
          "total_count": 123,
          "unique_count": 123
        }
      ],
      "device_model": [
        {
          "name": "<string>",
          "total_count": 123,
          "unique_count": 123
        }
      ],
      "client_name": [
        {
          "name": "<string>",
          "total_count": 123,
          "unique_count": 123
        }
      ],
      "timezone": [
        {
          "name": "<string>",
          "total_count": 123,
          "unique_count": 123
        }
      ],
      "language": [
        {
          "name": "<string>",
          "total_count": 123,
          "unique_count": 123
        }
      ],
      "referrer": [
        {
          "name": "<string>",
          "total_count": 123,
          "unique_count": 123
        }
      ],
      "interval": {
        "hour": [
          {
            "date": "<string>",
            "total_count": 123,
            "unique_count": 123
          }
        ],
        "day": [
          {
            "date": "<string>",
            "total_count": 123,
            "unique_count": 123
          }
        ],
        "week": [
          {
            "date": "<string>",
            "total_count": 123,
            "unique_count": 123
          }
        ],
        "month": [
          {
            "date": "<string>",
            "total_count": 123,
            "unique_count": 123
          }
        ],
        "year": [
          {
            "date": "<string>",
            "total_count": 123,
            "unique_count": 123
          }
        ]
      }
    }
  }
}

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.

start_date

string

required

Start date for filtering link analytics. Must be in 'YYYY-MM-DD' format.

end_date

string

required

End date for filtering link analytics. Must be in 'YYYY-MM-DD' format.

Response

Details of the requested Bitsy Link Analytics

status

enum<string>

required

Available options:

success

data

object

required

Show child attributes

data.timeframe

string

The time period for which the analytics data is being provided.

data.total_count

number

The total number of clicks during the specified timeframe.

data.unique_count

number

The count of unique clicks during the specified timeframe.

data.stats

object

Show child attributes

data.stats.country

object[]

Clicks by country.

Show child attributes

data.stats.country.name

string

The name of the country for geo-targeting.

data.stats.country.total_count

number

The total number of clicks from users in this country.

data.stats.country.unique_count

number

The number of unique clicks from users in this country.

data.stats.region

object[]

Clicks by region.

Show child attributes

data.stats.region.name

string

The name of the region for geo-targeting.

data.stats.region.total_count

number

The total number of clicks from users in this region.

data.stats.region.unique_count

number

The number of unique clicks from users in this region.

data.stats.city

object[]

Clicks by city.

Show child attributes

data.stats.city.name

string

The name of the city for geo-targeting.

data.stats.city.total_count

number

The total number of clicks from users in this city.

data.stats.city.unique_count

number

The number of unique clicks from users in this city.

data.stats.os_name

object[]

Clicks by operating system.

Show child attributes

data.stats.os_name.name

string

The name of the operating system used by the user.

data.stats.os_name.total_count

number

The total number of clicks from users on this operating system.

data.stats.os_name.unique_count

number

The number of unique clicks from users on this operating system.

data.stats.device_type

object[]

Clicks by device type.

Show child attributes

data.stats.device_type.name

string

The type of device used by the user (e.g., mobile, desktop).

data.stats.device_type.total_count

number

The total number of clicks from users on this device type.

data.stats.device_type.unique_count

number

The number of unique clicks from users on this device type.

data.stats.device_brand

object[]

Clicks by device brand.

Show child attributes

data.stats.device_brand.name

string

The brand of the device used by the user.

data.stats.device_brand.total_count

number

The total number of clicks from users with this device brand.

data.stats.device_brand.unique_count

number

The number of unique clicks from users with this device brand.

data.stats.device_model

object[]

Clicks by device model.

Show child attributes

data.stats.device_model.name

string

The specific model of the device used by the user.

data.stats.device_model.total_count

number

The total number of clicks from users with this device model.

data.stats.device_model.unique_count

number

The number of unique clicks from users with this device model.

data.stats.client_name

object[]

Clicks by client name.

Show child attributes

data.stats.client_name.name

string

The client used by the user (e.g., Chrome, Firefox).

data.stats.client_name.total_count

number

The total number of clicks from this client.

data.stats.client_name.unique_count

number

The number of unique clicks from this client.

data.stats.timezone

object[]

Clicks by timezone.

Show child attributes

data.stats.timezone.name

string

The name of the timezone in which the interaction occurred.

data.stats.timezone.total_count

number

The total number of clicks from users in this timezone.

data.stats.timezone.unique_count

number

The number of unique clicks from users in this timezone.

data.stats.language

object[]

Clicks by language.

Show child attributes

data.stats.language.name

string

The language used by the user.

data.stats.language.total_count

number

The total number of clicks from users speaking this language.

data.stats.language.unique_count

number

The number of unique clicks from users speaking this language.

data.stats.referrer

object[]

Clicks by referrer.

Show child attributes

data.stats.referrer.name

string

The referrer source from which the user arrived.

data.stats.referrer.total_count

number

The total number of clicks from users who came from this referrer.

data.stats.referrer.unique_count

number

The number of unique clicks from users who came from this referrer.

data.stats.interval

object

Clicks by various time intervals (hour, day, week, month, year).

Show child attributes

data.stats.interval.hour

object[]

Clicks by hour.

Show child attributes

data.stats.interval.hour.date

string

The date and time for the hour interval.

data.stats.interval.hour.total_count

number

The total number of clicks during this hour.

data.stats.interval.hour.unique_count

number

The number of unique clicks during this hour.

data.stats.interval.day

object[]

Clicks by day.

Show child attributes

data.stats.interval.day.date

string

The date for the day interval.

data.stats.interval.day.total_count

number

The total number of clicks during this day.

data.stats.interval.day.unique_count

number

The number of unique clicks during this day.

data.stats.interval.week

object[]

Clicks by week.

Show child attributes

data.stats.interval.week.date

string

The start date for the week interval.

data.stats.interval.week.total_count

number

The total number of clicks during this week.

data.stats.interval.week.unique_count

number

The number of unique clicks during this week.

data.stats.interval.month

object[]

Clicks by month.

Show child attributes

data.stats.interval.month.date

string

The start date for the month interval.

data.stats.interval.month.total_count

number

The total number of clicks during this month.

data.stats.interval.month.unique_count

number

The number of unique clicks during this month.

data.stats.interval.year

object[]

Clicks by year.

Show child attributes

data.stats.interval.year.date

string

The start date for the year interval.

data.stats.interval.year.total_count

number

The total number of clicks during this year.

data.stats.interval.year.unique_count

number

The number of unique clicks during this year.

Retrieve all Bitsy Links Update Bitsy Link

⌘I

API Documentation

Bitsy Link

Authorizations

Query Parameters

Response