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

​
id
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

200
application/json

Details of the requested Bitsy Link Analytics

The response is of type object.