Analytics
Get Link or Website Analytics
Retrieve detailed analytics for a short link or bio website
GET
Request
Headers
Path Parameters
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.comQuery Parameters
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_daysCustom range start date in
YYYY-MM-DD format. Must be used with to.Example: 2026-01-01Custom range end date in
YYYY-MM-DD format. Must be used with from.Example: 2026-01-31Bio 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
Resolved Firestore document ID used for analytics lookup.
Identifier from the request path.
Resource type, such as
Website or Deeplink.How the identifier was matched, such as
documentId, customSlug, or customDomain.Total views in the selected range.
Time-series analytics for the selected range. For short ranges this is hourly; for longer ranges this is daily or monthly.
View breakdown by device type.
Countries by view count.
Highest-view country in the selected range, excluding unknown values.
View count for
topCountry.Timestamp of the latest view, or
null when no view has been recorded.View breakdown by platform or operating system.
Referrer domains by view count.
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.
Adult confirmation metric for adult-gated links. Returns
null when no adult confirmation clicks were tracked in the selected range.