Retrieve a Bitsy Link Analytics - Bitsy Documentation

GET

link

stats

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

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

200

application/json

Details of the requested Bitsy Link Analytics

status

enum<string>

required

Available options:

success

data

object

required

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

data.stats.country

object[]

Clicks by country.

data.stats.region

object[]

Clicks by region.

data.stats.city

object[]

Clicks by city.

data.stats.os_name

object[]

Clicks by operating system.

data.stats.device_type

object[]

Clicks by device type.

data.stats.device_brand

object[]

Clicks by device brand.

data.stats.device_model

object[]

Clicks by device model.

data.stats.client_name

object[]

Clicks by client name.

data.stats.timezone

object[]

Clicks by timezone.

data.stats.language

object[]

Clicks by language.

data.stats.referrer

object[]

Clicks by referrer.

data.stats.interval

object

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

Was this page helpful?

Retrieve all Bitsy Links Update Bitsy Link

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

API Documentation

Bitsy Link

Authorizations

Query Parameters

Response