Skip to main content

Analytics API (Preview — Coming in API v2)

Status: The Analytics API is not available in API v1.
All analytics endpoints are currently in design and development and will be introduced in API v2.
The information on this page serves as a technical preview.

QRForge already captures and aggregates scan analytics for every dynamic QR code — including trends, countries, devices, and referrers — and makes this data available in the QRForge Dashboard.
Dedicated, general-purpose programmatic retrieval (trends, countries, devices, referrers) is not part of v1 — see below for the one exception that already ships.

What’s Available Today (v1)​

  • Full analytics visible in the QRForge Dashboard
  • Daily and hourly reporting inside the UI
  • No dedicated analytics endpoints — there is no /v1/analytics/... surface yet
  • No export-triggering endpoints through the API
  • A live scan counter is already available, though: GET /v1/qr-codes/{id} returns scan_count (total scans so far) and scan_limit (the configured cap, if any) directly in the QR response body. This isn't a dedicated analytics endpoint — it's just two fields on the existing single-QR-fetch response — and it is not currently included in the GET /v1/qr-codes list response.

If your organization requires custom analytics exports, please contact support for early access options.

Planned Capabilities for API v2 (Preview)​

The following endpoints are planned for API v2, focusing on enterprise‑grade analytics retrieval and integration workflows:

QR-Level Analytics​

  • GET /v2/analytics/qr-codes/{qr_id}/trend
  • GET /v2/analytics/qr-codes/{qr_id}/countries
  • GET /v2/analytics/qr-codes/{qr_id}/devices
  • GET /v2/analytics/qr-codes/{qr_id}/referrers
  • GET /v2/analytics/qr-codes/{qr_id}/hours

These endpoints will provide:​

  • Daily scan time-series
  • Country breakdown
  • Device breakdown
  • Referrer attribution
  • Hour-of-day and day-of-week patterns
  • Aggregated or raw views depending on plan
  • BigQuery‑backed, high‑performance analytics suitable for enterprise workloads

Export-Oriented Analytics (Future Roadmap)​

A CSV export engine already exists and ships today — it's just not reachable through the public API yet. From the QRForge Dashboard, you can trigger an export job that generates a downloadable CSV of your data; this is a Dashboard-triggered workflow, not a REST call you can make programmatically.

In addition to that, QRForge will introduce analytics export jobs exposed as public API endpoints, allowing:

  • Large CSV or NDJSON exports, triggerable via the API
  • Scheduled exports
  • Webhook notifications when exports complete
  • Download URLs stored in Firebase Storage or GCS
  • BigQuery table mirroring for enterprise customers

These export-focused endpoints are planned for v2.

Stability, Backward Compatibility & Versioning​

  • API v2 analytics endpoints will be additive, with no breaking changes to v1 endpoints.
  • All analytics endpoints will follow the same API key authentication strategy (x-api-key).
  • Pagination, filtering, and rate‑limits will align with v2 API standards.

Early Access​

Teams needing early access to analytics capabilities can contact support to discuss private beta options.