Skip to main content
GET

Request

Headers

Path Parameters

string
required
The link or website identifier. For websites, you can use the document ID, custom slug, or custom domain.Examples: link_abc123xyz, my-bio-page, example.com

Query Parameters

string
Preset date range. Supported values are last_7_days, last_30_days, last_90_days, this_month, last_month, and all_time.Example: last_30_days
string
Custom range start date in YYYY-MM-DD format. Must be used with to.Example: 2026-01-01
string
Custom range end date in YYYY-MM-DD format. Must be used with from.Example: 2026-01-31
Bio website button clicks are returned in clicksByLink. Each tracked button includes the link ID, title, URL, total clicks, and daily clicks for the selected range.

Response

string
Resolved Firestore document ID used for analytics lookup.
string
Identifier from the request path.
string
Resource type, such as Website or Deeplink.
string
How the identifier was matched, such as documentId, customSlug, or customDomain.
number
Total views in the selected range.
array
Time-series analytics for the selected range. For short ranges this is hourly; for longer ranges this is daily or monthly.
object
View breakdown by device type.
array
Countries by view count.
string
Highest-view country in the selected range, excluding unknown values.
number
View count for topCountry.
string | null
Timestamp of the latest view, or null when no view has been recorded.
object
View breakdown by platform or operating system.
array
Referrer domains by view count.
number
Total tracked clicks in the selected range. For bio websites, this is the total clicks across tracked buttons.
Click breakdown by tracked link or button.
object | null
Adult confirmation metric for adult-gated links. Returns null when no adult confirmation clicks were tracked in the selected range.