Skip to content

Analytics

GET /api/v1/analytics/overview

Required scope: analytics:read

Query parameters

Parameter Type Description
qrCodeId UUID, optional Restrict the result to one QR campaign.
fromUtc ISO 8601 UTC, optional Start of the reporting window. Defaults to 30 days before toUtc.
toUtc ISO 8601 UTC, optional End of the reporting window. Defaults to now.

The maximum reporting window is 366 days, and the end date cannot be in the future.

The response includes total scans, privacy-preserving unique scans, daily time-series points, and breakdowns for countries, cities, devices, operating systems, browsers, and traffic sources. Unique scans are estimates based on privacy-preserving visitor signals—not permanent visitor identities.