Resources

Product Documentation

Getting started, plans and billing, the API, analytics, integrations, and security—everything you need in one place.

Sign Up Free
On this page

Guides

[ Documentation ]

Getting Started

Core concepts and the minimal steps to create, publish, and measure your first dynamic QR code with BaseQR.

Who it’s for

New users, evaluators, and contributors.

You will learn

  • Why BaseQR uses dynamic QR codes and how they differ from static, fixed-destination codes.
  • How BaseQR organizes work.
  • How to create your first campaign and dynamic QR code.
  • How to test, publish, and measure results with Total Scans.
  • How to collaborate using Admin and User roles.

Prerequisites

  • Create an account and complete email verification.
  • On first login, create your organization.
  • (Enterprise only) SSO is available after provisioning by an Admin.

Dynamic vs static QR codes

Why dynamic QR codes (BaseQR)

  • Definition: A QR code whose destination can be changed after creation (“midstream”) without regenerating or reprinting the code.
  • Purpose: Keep a single code live across print and digital while preserving continuous analytics and campaign attribution.
  • Uses: Long-running initiatives, packaging, events, retail, and placements where content or routing may evolve.
  • Measurement: Enables uninterrupted reporting of Total Scans even as destinations change.

Static QR codes (fixed destination)

  • Definition: A QR code whose destination is permanently fixed at creation.
  • Limitations: Cannot be altered; any change requires generating a new code and updating all placements and assets.
  • Measurement: Tracking or attribution changes typically require issuing a new code and redistributing artwork.

BaseQR focuses on dynamic QR codes to enable post-creation changes and continuous measurement without operational rework.

How work is organized

  • Organization: Top-level account and billing context.
  • Campaigns: Primary container for QR codes, assets, and reporting. Your first action is to create a campaign.
  • QR codes (dynamic): Individual scannable codes managed within campaigns.

Note: In some contexts, “project” may refer to the same concept as a campaign.

Roles and permissions

  • Admin: Organization settings, billing, user management, and access to all campaigns.
  • User: Create and manage campaigns and QR codes as permitted by the organization.

Analytics overview

  • Base metric: Total Scans.
  • Standard views include time series, geography, device/referrer breakdowns, and UTM-based reporting.
  • CSV, Excel, and PDF exports are available from reporting views for offline analysis and stakeholder reviews.

Privacy

  • Analytics are anonymous by default. BaseQR does not collect PII from scans.
  • For storage locations, retention, access controls, and shared responsibility, read the Data Security section on this page.

First five minutes (quick start)

  1. Sign up and verify email.
  2. Create your organization. Add a display name and confirm billing owner (adjust later if needed).
  3. Create your first campaign (two steps): choose a descriptive name (e.g. “Q4 Launch – Print Inserts”) and a description covering purpose, audience, and channel. Keep naming consistent across teams.
  4. Create a dynamic QR code in that campaign: select Dynamic and set an initial Destination URL (changeable later).
  5. Add UTM parameters to destination URLs for attribution—use stable values for utm_source, utm_medium, and utm_campaign so reporting stays comparable over time.
  6. Test the code across devices and networks: confirm the destination loads over HTTPS, UTMs appear in the final URL, and mobile performance is acceptable.
  7. Export the QR (PNG, SVG, or PDF) for print or embed in digital channels at the resolution your channel requires.
  8. Publish and place the QR where it will be scanned. In low-signal areas, prefer short URLs and lightweight landing pages so scans complete reliably.
  9. Monitor performance in the Campaign Dashboard using Total Scans and UTM breakdowns.
  10. Invite teammates from organization settings, assigning Admin or User roles according to who should manage billing versus day-to-day campaigns.

Recommendation: Start with one campaign per brand or initiative. Use clear, descriptive names and keep UTM conventions documented in the campaign description.

Additional topics

Short summaries of areas that extend the quick start—all covered here without sending you off-site.

Possibilities with BaseQR

Beyond a single link: dynamic destinations, A/B routing, geo rules, scheduled changes, and branded short URLs—so the same printed code can support launches, regional offers, and post-campaign pivots without new artwork.

Workflow

Typical flow: define the campaign and audience, create codes with destinations and UTMs, validate with test scans, export assets for creative, publish, then monitor Total Scans and breakdowns. Revisit destinations as offers or compliance needs change.

Project management

Treat each campaign as the unit of work: align codes to initiatives, document naming and UTM rules in the description, and use roles so admins govern org-wide settings while users ship day-to-day updates.

Collaboration

Admins invite users, manage seats, and control billing; users create and edit campaigns and codes. Share context in campaign descriptions (goals, channels, regions) so handoffs between marketing, ops, and agencies stay clear.

Placement and testing

Validate size, contrast, and quiet zone for print; test on real devices and networks before scale. For packaging and OOH, plan for distance-to-scan and lighting. Re-scan after any creative revision.

Profile & administration

Admins maintain organization profile, billing, seat limits, and API keys. Users focus on campaigns and codes. Enterprise teams can centralize sign-in with SSO when enabled on the account.

Troubleshooting & FAQs

If scans fail, check destination uptime, HTTPS, redirects, and whether the code is active. If reporting looks wrong, verify UTMs on resolved URLs and timezone/reporting windows. For API jobs, inspect error payloads and retry idempotently.

Resources & help

Use in-product help and this documentation hub for concepts; contact support through your account channels for billing or access issues. For security concerns, follow the vulnerability reporting process described under Data Security.

Compare plans · Contact sales

[ Documentation ]

Resources & Help

This section centralizes reference materials and support channels for BaseQR. Use it to find product changes, implementation guidance, and ways to get assistance.

What this section covers

  • Release Notes — Summaries of product changes and improvements.
  • Playbooks — Step-by-step guidance for common implementations and reviews.
  • Support Options — Available channels and what to prepare before opening a ticket.
  • Contact Us — How to reach the team for sales, billing, or technical questions.

How to use these resources

  • Stay current — Review Release Notes regularly to understand new capabilities and fixes that may affect your workflows.
  • Start with a template — Use Playbooks to standardize tasks such as campaign setup, pre-flight reviews, or bulk updates.
  • Resolve faster — Check Support Options for the appropriate channel and include the requested details (for example, code ID, timestamps, final URL with UTMs) to speed triage.
  • Route requests correctly — Use Contact Us for sales and billing inquiries; use support channels for technical issues.

When to consult this section

  • Before major launches or migrations (to confirm current capabilities).
  • After noticing a change in behavior (to verify recent updates).
  • When establishing internal standards (to base them on recommended practices).
  • When you need assistance beyond this documentation.

Related pages (full documentation hub)

  • Support Options, Playbooks, Release Notes, and Contact Us — available in the BaseQR documentation at https://baseqr.ai/docs/resources-and-help alongside deeper navigation for each topic.

Other documentation areas

  • Getting Started, Create and Manage, Placement and Testing, Analytics and Reporting, Developers, Integrations, Profile & Administration, Plans & Billing, Data Security, Troubleshooting & FAQs — explore the same hub for end-to-end coverage.

[ Documentation ]

Troubleshooting & FAQs

A concise path to diagnose common issues in BaseQR and answers to frequently asked questions. Follow the triage steps in order, then verify fixes with a quick scan test and GA4 Real-Time where applicable.

Scans fail to open or resolve to the wrong page

  • Confirm the code is Active.
  • Open the code in BaseQR and verify the destination URL is correct and uses HTTPS.
  • Scan on iOS and Android over Wi-Fi and cellular; avoid testing screenshots or scaled mockups.
  • If downstream pages are slow or unavailable, temporarily point to a lightweight page using Dynamic Destinations; retest, then restore when healthy.
  • If redirects are used, ensure UTMs persist through all hops.

Low or inconsistent scan rates

  • Recheck the final artifact for size vs. viewing distance, quiet zone, and contrast; increase size and improve background if needed.
  • Validate placement context (dwell time, glare, curvature).
  • Test in bright, dim, and mixed lighting on recent iOS and Android devices.

UTMs missing or GA4 doesn't match BaseQR

  • Scan and inspect the final URL; confirm utm_source, utm_medium, utm_campaign (and optional utm_content / utm_term).
  • Verify that redirects, CDNs, or link tools do not strip or duplicate UTMs.
  • Normalize casing (lowercase) and keep the UTM pattern stable mid-campaign.
  • Expect differences: BaseQR counts Total Scans; GA4 counts sessions after page load and may filter traffic. Compare trends and rates.

Bulk import, create, or update errors

  • Start from the current Bulk Import Template (CSV, UTF-8, single header row).
  • Validate HTTPS destination URLs and UTM formatting before upload.
  • Fix only the failed rows reported by validation and re-import.

Export issues (assets or reports)

  • Assets: prefer SVG for print; if raster, export PNG or JPG at sufficient pixel dimensions for the final size.
  • Reports: confirm date range and optional campaign filter; choose the correct report type (Total Scans, Devices, Locations, Time Patterns).

Access, seats, or invitations

  • Invitations require available seats and must be sent by an Admin.
  • Check Account → Billing for plan and seat status (Starter: 1 seat • Pro: 5 seats • Enterprise: 10 seats).

Service availability questions

  • Review the Uptime Status page for current status and incident notes.
  • During downstream issues on your site or app, use Dynamic Destinations or set codes Inactive until resolved.

Preventive checks (before launch or major changes)

  • Run the Pre-flight Checklist on the final printed or digital artifact.
  • Keep utm_campaign identical to the campaign name; apply the agreed UTM convention consistently.
  • Add goals, placements, audience or regions, and your UTM plan to the campaign description for team alignment.

FAQs

  • Can I change a destination after printing? — Yes. Use Dynamic Destinations to update the URL without reprinting; analytics continuity is preserved.
  • Can I change UTMs mid-campaign? — Yes. Update UTMs in BaseQR (or via bulk import) and retest. Keep utm_campaign unchanged for clean comparisons.
  • Why do BaseQR scans and GA4 sessions differ? — They measure different events. BaseQR counts the scan; GA4 counts the session after page load and may filter traffic. Align on trends and rates.
  • How do I pause a code? — Set status to Inactive. Reactivate when ready.
  • Do you support code expiration? — No. Use Inactive to stop new scans when a campaign ends.
  • Who can invite teammates and manage roles? — Admins only. Roles are Admin and User at the organization level.
  • Can I limit external users to specific campaigns? — No. Organization access is not restricted by campaign; external Users have the same permissions as internal Users.
  • What columns are required for bulk import? — Use the current Bulk Import Template in the product for required and optional fields and status updates at scale.
  • How do I keep long-term analytics? — In-product visibility windows vary by plan. Export reports (CSV, Excel, PDF) on a cadence for long-term records.
  • Does BaseQR collect PII from scans? — No. Analytics are anonymous. Downstream analytics (e.g. GA4) and consent are managed on your destination pages.

When to escalate

  • Include campaign and code name or ID, UTC timestamps, device and OS, network (Wi-Fi or cellular), final URL with UTMs, and (for imports) the CSV header and a few example rows (sanitized). Reference any relevant entries on the Uptime Status page.

Full documentation hub

  • Common Issues, FAQs, and Advanced User FAQs — see https://baseqr.ai/docs/troubleshooting-and-faqs for the live navigation and related sections (Getting Started, Placement and Testing, Data Security, Resources & Help, and more).

[ Documentation ]

Plans & Billing

How plans, seats, and billing work in BaseQR, and where to manage upgrades, trials, invoices, and payments.

Plan tiers and seats

  • Seat availability determines how many users you can invite. When seats are full, new invitations are blocked until a seat is freed or the plan is upgraded.
  • Starter (Free) — 1 seat. Suitable for individual evaluation or very small pilots.
  • Pro — 5 seats. Designed for small teams coordinating across a few campaigns.
  • Enterprise — 10 seats. Intended for larger teams; Single Sign-On (SSO) is available on this tier.

Trials & upgrades

  • Start a trial from Account → Billing (Admins). Trials convert to the selected plan unless canceled before the trial end.
  • Upgrade to increase available seats immediately; invite teammates after the change is confirmed.
  • Downgrade requires reducing active users to at or below the new seat limit before completing the change.

Invoices & payments

  • Where: Account → Billing (Admins).
  • Manage: Update payment method, view and download invoices, and review plan status and renewal dates.

Changing your plan

  • Upgrade: Takes effect as soon as payment is processed; additional seats become available.
  • Downgrade: Adjust active users to match the lower seat limit, then confirm the change.
  • Cancel at period end: Access remains through the current billing period; plan changes apply at renewal.

Operational guidance

  • Before inviting: Confirm available seats or upgrade first to avoid blocked invitations.
  • Seat hygiene: Periodically review membership to align seats with active projects.
  • SSO (Enterprise): If your organization requires centralized sign-in, enable SSO after moving to Enterprise.

Where to manage billing

  • Navigation: Lower-left sidebar → Account → Billing (Admins).

[ Documentation ]

Developers

Using the BaseQR API for automation and system-to-system workflows: authentication, request patterns, endpoint concepts, and troubleshooting.

What this section covers

  • API quickstart — Authenticate with an API key, make your first request, and follow a minimal flow from creating a code to updating its destination and UTMs.
  • Endpoints — Primary resources include campaigns, codes, and destinations with common operations: create, update, list, and export. Request and response fields are defined in the in-product API reference.
  • Error codes & troubleshooting — Errors include machine-readable codes and messages. Typical causes include bad credentials, validation failures, and rate limits; fix the underlying request and retry with idempotency in mind.

Authentication and security

  • API keys — Admins create and revoke keys in Settings → API Keys. Keys inherit organization-level access. Store keys in a secure secret manager; avoid client-side use.
  • Requests — Include the API key in request headers as specified in your workspace API settings. Use HTTPS for all calls.
  • Rotation — Rotate keys on a regular cadence and whenever roles change. Revoke exposed keys immediately and replace them before resuming jobs.

Typical build flow

  • Create a campaign — Use the API to create or select a campaign (name and description). Follow your internal naming standard for consistency.
  • Create codes — Create one or many QR codes in the campaign. Provide the initial destination URL; UTMs may be included at creation or added later.
  • Update midstream — Change destinations or UTM parameters at any time without reprinting. Use small, verifiable batches and confirm changes with a quick scan test.
  • Export assets — Retrieve SVG/PNG/JPG for downstream systems that assemble print or digital creatives.
  • Report and reconcile — Use API exports or in-app reports for Total Scans; align with GA4 using your UTM convention.

Reliability and safety

  • Idempotency — Design jobs so retries do not create duplicates (for example, supply a client reference ID when supported, or check-before-create patterns).
  • Validation — Validate URLs, required fields, and UTM formatting before sending. Reject rows that fail basic checks during bulk operations.
  • Monitoring — Log request/response metadata, handle non-2xx statuses explicitly, and alert on successive failures.

Best practices

  • Keep UTMs consistent — Standardize utm_source, utm_medium, and utm_campaign so GA4 reports align with BaseQR scans.
  • Batch with care — For large imports/updates, start with a small subset, verify, then scale up.
  • Document context — Write goals, placements, audience/regions, and UTM plan in the campaign description for handoffs across teams.

[ Documentation ]

Analytics & Reporting

How BaseQR measures scan activity and how to combine those metrics with your analytics stack for attribution and outcomes analysis.

What this section covers

  • Scan measurement — BaseQR records Total Scans per code and campaign, with views that break down activity by device, location, and time patterns.
  • Campaign dashboard — Overview of campaign-level performance for quick monitoring.
  • Attribution with UTMs — How to apply a consistent UTM pattern so GA4 reporting aligns with BaseQR scans.
  • Conversion tracking — How to connect scans to downstream behavior in GA4 (and, if used, GTM on your site).
  • Report exporting — How to export CSV, Excel, or PDF summaries for stakeholders.

Core concepts

  • Total Scans — The primary metric in BaseQR. Counts every successful scan of a code. Use this for volume and trend analysis.
  • Breakdowns — Analyze scans by device/OS, location, and time patterns to understand context and peak windows.
  • UTM alignment — Apply a stable source/medium/campaign convention so BaseQR scan counts and GA4 sessions are comparable by campaign and channel.
  • Complementary views — BaseQR shows scan activity; GA4 shows on-site behavior and conversions. Use both for a complete picture.
  • Exports — Create shareable summaries for reviews and reporting in CSV, Excel, or PDF.

Recommended approach

  • Plan first — Define your UTM convention and add it to the campaign description for team-wide consistency.
  • Monitor routinely — Use the campaign dashboard for a quick read; drill into breakdowns to identify channel or timing issues.
  • Validate attribution — Spot-check UTMs in final URLs and confirm GA4 Real-Time reflects the expected buckets.
  • Share results — Export BaseQR reports and pair them with GA4 dashboards to communicate both scan volume and outcomes.

[ Documentation ]

Integrations

How BaseQR works with your analytics and automation stack—high-level guidance for GA4/UTM and API keys.

What this section covers

  • Google Analytics — How to attribute QR-driven traffic in GA4 using UTM parameters on your destination URLs.
  • API Keys — How to create and manage API credentials for automation and system-to-system workflows.

Core concepts

  • Data flow — BaseQR records scans (Total Scans). Downstream behavior (sessions, engagement, conversions) is measured by your analytics on the destination pages (for example, GA4). UTMs connect these views.
  • UTM alignment — A simple, consistent UTM convention ensures GA4 reporting lines up with BaseQR scans by campaign and channel.
  • Privacy — BaseQR analytics are anonymous; no PII is collected. GA4 configuration and consent are managed on your site.

How integrations are set up

  • Google Analytics — Implement GA4 (optionally via GTM) on the destination pages your QR codes resolve to. Append UTMs to your URLs in BaseQR so GA4 can attribute traffic correctly. No reprinting is required for mid-campaign UTM adjustments.
  • API Keys — Create API credentials in Settings to enable programmatic tasks such as creating codes, updating destinations, or exporting data. Store keys securely and rotate when team membership changes.

Best practices

  • Document the plan — Add your UTM convention and measurement goals to the campaign description so collaborators tag links consistently.
  • Validate end-to-end — After creating a code, scan it and confirm: the destination loads, UTMs are present, and GA4 Real-Time shows the expected source/medium/campaign.
  • Secure automation — Limit API key distribution, prefer per-system keys, and revoke credentials that are no longer needed.

[ Documentation ]

Data Security

How data flows through BaseQR, who can access it, operational practices for storage and availability, and how responsibility is shared with your team.

Scope

  • Application data — Organization records, campaigns, and QR codes (including destinations and UTM parameters).
  • Analytics data — Scan activity used for reporting (Total Scans, device/OS, location, time patterns). Analytics are anonymous; BaseQR does not collect PII from scans.
  • Account data — User identity and role information used for sign-in, invitations, and collaboration features.

Access model

  • Organization-level access — Access is scoped to an organization. All users in an organization can see newly created campaigns.
  • Roles — Admin (manages users/roles and can delete campaigns; includes all User capabilities) and User (creates and manages campaigns and QR codes, updates destinations/UTMs, toggles Active/Inactive, exports assets/reports).
  • Enterprise SSO (optional) — Available on Enterprise plans for centralized authentication through your identity provider.

Data handling principles

  • Data minimization — QR analytics focus on scan events and context needed for reporting; PII is not collected from scans.
  • Change without reprint — Destinations and UTMs can be updated midstream; analytics continuity is preserved under the same code.
  • Customer control — Admins manage membership and roles; organizations control their own destination URLs and tagging conventions.

Privacy and attribution

  • UTM alignment — UTMs applied to destination URLs enable downstream attribution in your analytics (for example, GA4).
  • Customer-owned consent — Consent, cookies, and tracking on destination pages are controlled by your site/app and analytics configuration.

Storage, availability, and incidents

  • Data storage & retention — Customer configuration and scan analytics are stored in managed cloud infrastructure with defined retention aligned to your plan. Admins can request data deletion paths consistent with contract and legal obligations.
  • Uptime and service levels — The service is designed for high availability; published targets and current status appear in the product status experience. Planned maintenance is communicated in advance when possible.
  • Incident response — Events are monitored, triaged by on-call engineers, and communicated through status channels when customer impact occurs. Post-incident reviews drive preventive fixes.
  • Compliance posture — Security and privacy practices follow industry-standard controls; customers with regulatory needs should review Data Processing terms with their legal team.
  • Vulnerability reporting — Report suspected vulnerabilities through the security contact provided in your agreement or support portal. Do not perform disruptive testing against production without written authorization.

Shared responsibility

  • You manage destinations — Ensure destination pages are reachable over HTTPS and perform well on mobile, especially in low-signal environments.
  • You manage analytics — Implement GA4 (and optionally GTM) and maintain a consistent UTM convention for accurate attribution.
  • We provide controls — Organization-level roles, campaign and code management, asset exports, and reporting.