Get yearly calendar heatmap (click count per day, last 365 days)

GET

/api/v1/links/{code}/analytics/calendar-heatmap

curl --request GET \
  --url https://example.com/api/v1/links/example/analytics/calendar-heatmap \
  --header 'Authorization: Bearer <token>'

Authorizations

• bearer

Parameters

Path Parameters

code

required

string

Short code or custom alias

Responses

200

Media typeapplication/json

object

shortCode

required

string

from

required

string

to

required

string

totalClicks

required

number

data

required

Array<object>

object

date

required

Date string YYYY-MM-DD

string

clicks

required

number

Example ^generated

{
  "shortCode": "example",
  "from": "example",
  "to": "example",
  "totalClicks": 1,
  "data": [
    {
      "date": "example",
      "clicks": 1
    }
  ]
}

403

Forbidden — not the owner

404

Link not found