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.
However, programmatic retrieval via API is not part of v1.

What’s Available Today (v1)​

  • Full analytics visible in the QRForge Dashboard
  • Daily and hourly reporting inside the UI
  • No public REST endpoints for analytics
  • No export-triggering endpoints through the API

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)​

In addition to retrieval endpoints, QRForge will introduce analytics export jobs, allowing:

  • Large CSV or NDJSON exports
  • 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 will launch shortly after 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.