# Scanova API Documentation ## Docs - [Export Analytics Data](https://docs.scanova.io/api-reference/endpoint/analytics/export.md): Export QR Code analytics as downloadable reports in Excel (XLS/XLSX) or PDF format. Ideal for detailed performance reviews, audits, and external analysis in tools like Excel, Google Sheets, or BI dashboards. Authentication required. - [Export Raw Scan Data](https://docs.scanova.io/api-reference/endpoint/analytics/export-raw.md): Download row-level scan logs for one or more QR codes, using the same filters as the aggregate analytics export endpoint. Ideal for custom BI pipelines, reconciliations, or detailed auditing. - [QR Code Analytics](https://docs.scanova.io/api-reference/endpoint/analytics/qr-code.md): Retrieve in-depth QR Code performance analytics including scan counts, devices, operating systems, browsers, geographic insights, and time-based metrics. Supports filtering, grouping, and multiple analytic types in a single request. Authentication required. - [Account Statistics](https://docs.scanova.io/api-reference/endpoint/analytics/stats.md): Retrieve comprehensive usage statistics for your Scanova account — including QR code counts, scan activity, and feature utilization. Use the optional fields parameter to fetch only the specific metrics you need. Authentication required. - [Move QR Codes to Folder](https://docs.scanova.io/api-reference/endpoint/folder_management/bulk-move.md): Move multiple QR codes into a folder. Authentication required — include your API key in the Authorization header. - [Bulk Unassign QR Codes from Folder](https://docs.scanova.io/api-reference/endpoint/folder_management/bulk-unassign.md): Remove multiple QR codes from a folder in a single request. Authentication required — include your API key in the Authorization header. - [Create Folder](https://docs.scanova.io/api-reference/endpoint/folder_management/create.md): Creates a folder for QR codes or pages. Requires authentication. - [Delete Folder](https://docs.scanova.io/api-reference/endpoint/folder_management/delete.md): Delete a folder, optionally moving QR codes to Uncategorized or permanently deleting them. Authentication required — include your API key in the Authorization header. - [List Folders](https://docs.scanova.io/api-reference/endpoint/folder_management/list.md): Retrieves folders by type (QR or Page). Requires authentication. - [Update Folder](https://docs.scanova.io/api-reference/endpoint/folder_management/update.md): Renames a folder. Requires authentication. - [Attach Form to QR Code](https://docs.scanova.io/api-reference/endpoint/form/attach.md) - [Delete Form](https://docs.scanova.io/api-reference/endpoint/form/delete.md): Deletes a form permanently. Requires authentication. - [Detach Form from QR Code](https://docs.scanova.io/api-reference/endpoint/form/detach.md) - [List Form](https://docs.scanova.io/api-reference/endpoint/form/list.md): Retrieves all forms with optional filtering. Requires authentication. - [Retrieve Form](https://docs.scanova.io/api-reference/endpoint/form/retrieve.md): Retrieves details of a specific form. Requires authentication. - [Update Form](https://docs.scanova.io/api-reference/endpoint/form/update.md): Updates a form's name or active status. Requires authentication. - [Attach Lead List to QR Code](https://docs.scanova.io/api-reference/endpoint/lead_list/attach.md) - [Delete Lead List](https://docs.scanova.io/api-reference/endpoint/lead_list/delete.md): Deletes a lead list permanently. Requires authentication. - [Detach Lead List from QR Code](https://docs.scanova.io/api-reference/endpoint/lead_list/detach.md) - [List Lead Lists](https://docs.scanova.io/api-reference/endpoint/lead_list/list.md): Retrieves all lead lists with optional filtering. Requires authentication. - [Retrieve Lead List](https://docs.scanova.io/api-reference/endpoint/lead_list/retrieve.md): Retrieves details of a specific lead list. Requires authentication. - [Update Lead List](https://docs.scanova.io/api-reference/endpoint/lead_list/update.md): Updates a lead list's name or active status. Requires authentication. - [Get QR Code Categories](https://docs.scanova.io/api-reference/endpoint/qr_manager/categories.md): Retrieves all available QR Code categories. Supports optional filtering via view_type. Authentication required — include your API key in the Authorization header. - [Create QR Code](https://docs.scanova.io/api-reference/endpoint/qr_manager/create.md): Creates a new dynamic QR Code with the specified category and content. Authentication required — include your API key in the Authorization header. - [Delete QR Code](https://docs.scanova.io/api-reference/endpoint/qr_manager/delete.md): Permanently deletes a QR Code from your account. This action cannot be undone. Requires authentication. - [Download QR Code](https://docs.scanova.io/api-reference/endpoint/qr_manager/download.md): Download a QR Code image in multiple formats (PNG, JPG, PDF, SVG, EPS) with a customizable size. The size parameter defines both the width and height in pixels (range: 10–1000, default: 300). Authentication required. - [Download QR Code (Printable)](https://docs.scanova.io/api-reference/endpoint/qr_manager/download-printable.md): Generate a print-optimized QR Code in black and white for professional printing. This endpoint ensures only black ink (CMYK: 0) is used, reducing printing costs and maintaining maximum scan contrast. Authentication required. - [Get QR Code List](https://docs.scanova.io/api-reference/endpoint/qr_manager/get.md): Retrieves a paginated list of QR Codes in your account with full metadata, advanced configuration flags, and analytics fields. Supports filtering, sorting, and search. Authentication required. - [Manage Trash QR Codes](https://docs.scanova.io/api-reference/endpoint/qr_manager/trash.md): Retrieve all QR Codes that have been deleted (moved to trash) from your Scanova account. Use this endpoint to view and manage QR codes that are no longer active but not yet permanently removed. Authentication required. - [Update QR Code](https://docs.scanova.io/api-reference/endpoint/qr_manager/update.md): Update an existing QR Code. Certain fields — category, qr_type, and custom_domain — cannot be changed once a QR Code is created. Authentication required. - [Validate QR Code Info Data](https://docs.scanova.io/api-reference/endpoint/qr_manager/validate-info.md): Validate QR Code info data before creating or updating a QR Code. Ensures the JSON payload structure and content are correct and prevents landing page or data errors. Authentication required via API key. - [Add New User](https://docs.scanova.io/api-reference/endpoint/user_management/add.md): Add a new user to your account by sending an invitation. The user will receive an email invitation to join your account with the specified role. - [Get User List](https://docs.scanova.io/api-reference/endpoint/user_management/list.md): Get a list of all users in your account including shared users, their roles, and invitation status. - [Remove User](https://docs.scanova.io/api-reference/endpoint/user_management/remove.md): Remove a user from your account. This will revoke their access and remove them from the shared user list. - [Get User Details](https://docs.scanova.io/api-reference/endpoint/user_management/retrieve.md): Get the details of a specific user including their role, permissions, and invitation status. - [Get User Roles List](https://docs.scanova.io/api-reference/endpoint/user_management/roles.md): Get a list of all user roles available in your account. This includes default roles (Manager, Admin, Viewer) as well as custom created roles with their permissions. - [Update User Role](https://docs.scanova.io/api-reference/endpoint/user_management/update-role.md): Update the role/access level of an existing user. This allows you to change a user's permissions without removing and re-adding them. - [Authentication](https://docs.scanova.io/api-reference/getting-started/authentication.md): Learn how to authenticate with the Scanova API using API keys - [Introduction](https://docs.scanova.io/api-reference/getting-started/introduction.md): Scanova API Documentation - Create and manage QR codes programmatically - [Design Assets](https://docs.scanova.io/api-reference/references/appendix.md): Complete reference for pre-designed logos, icons, and frames, as well as list of eye and data patterns available in Scanova. - [QR Code Category List](https://docs.scanova.io/api-reference/references/category-list.md): Complete reference of all available QR Code categories and their corresponding IDs. - [QR Code Info Components](https://docs.scanova.io/api-reference/references/components.md): When creating QR codes, the info parameter contains JSON data that varies based on the category. This page documents all the available components and their structure. - [Deprecated Endpoints](https://docs.scanova.io/api-reference/references/deprecated-endpoints.md): List of deprecated API endpoints and their replacement endpoints. Please migrate to the new endpoints as deprecated endpoints may be removed in future versions. - [QR Code Design](https://docs.scanova.io/api-reference/references/pattern-info.md): Complete reference for QR Code visual customization — all available options, allowed values, and example configurations. - [API Response Codes](https://docs.scanova.io/api-reference/references/response-codes.md): Complete reference of HTTP status codes returned by Scanova API endpoints. - [API Authentication](https://docs.scanova.io/conversion-tracking/api/authentication.md): How to authenticate server-side Conversion Tracking API requests using site-scoped API keys. - [Browser Events API — POST /ct](https://docs.scanova.io/conversion-tracking/api/browser-events.md): Reference for the browser event collection endpoint. Used by the Scanova Browser SDK to send page views, clicks, and custom events from user browsers. - [Conversion Analytics](https://docs.scanova.io/conversion-tracking/api/ct-analytics.md): Generate conversion analytics for selected QR Codes, with KPI, trend, event/site breakdown, and funnel outputs. - [Export Conversion Analytics](https://docs.scanova.io/conversion-tracking/api/ct-export.md): Export aggregated conversion analytics in CSV/XLS/XLSX formats. - [Export Raw Conversion Events](https://docs.scanova.io/conversion-tracking/api/ct-raw.md): Export row-level conversion events in CSV/XLS/XLSX formats. - [Errors & Rate Limits](https://docs.scanova.io/conversion-tracking/api/errors-rate-limits.md): HTTP status codes, error response format, rate limits, and error handling guidance for Scanova Conversion Tracking APIs. - [Batch Server Events API — POST /server-events/batch](https://docs.scanova.io/conversion-tracking/api/events-batch.md): Send up to 100 server-side conversion events in a single authenticated request. Recommended for queued delivery and high-volume backends. - [Server Events API — POST /server-events](https://docs.scanova.io/conversion-tracking/api/events-collect.md): Send a single authenticated server-side conversion event — purchase, signup, lead, or any backend action — attributed to a QR Code scan. - [Auto-Tracked Events](https://docs.scanova.io/conversion-tracking/browser/auto-tracking.md): What the Scanova Browser SDK tracks automatically — page views, clicks, scroll depth, and form submissions. See the exact event type, metadata, and payload for each. - [Custom Events](https://docs.scanova.io/conversion-tracking/browser/custom-events.md): Track specific user actions on your website using scanova('track', ...) — button clicks, sign-ups, video plays, and any other interaction you care about. - [Install the Browser SDK](https://docs.scanova.io/conversion-tracking/browser/install.md): Add the Scanova tracking snippet to your website directly in HTML or via Google Tag Manager. Works with any website, CMS, or frontend framework. - [Browser SDK Overview](https://docs.scanova.io/conversion-tracking/browser/overview.md): Track user behaviour on your website after a QR Code scan using the Scanova Browser SDK — page views, clicks, scroll depth, form submissions, and custom events. - [SDK Configuration Reference](https://docs.scanova.io/conversion-tracking/browser/sdk-configuration.md): All Scanova Browser SDK init options explained — auto-tracking flags, debug mode, custom endpoint, and defaults. - [SPA & Framework Setup](https://docs.scanova.io/conversion-tracking/browser/spa-frameworks.md): Install the Scanova Browser SDK in React, Next.js, Vue, and other single-page application frameworks. Avoid double-init and capture route-change page views correctly. - [Verify & Debug Browser SDK](https://docs.scanova.io/conversion-tracking/browser/verify.md): Confirm the Scanova Browser SDK is installed correctly, events are being sent, and attribution is working. Step-by-step DevTools checklist. - [Changelog](https://docs.scanova.io/conversion-tracking/changelog.md): Updates and improvements to Scanova Conversion Tracking documentation and SDK. - [Event Model Reference](https://docs.scanova.io/conversion-tracking/event-model.md): Complete field reference for browser and server conversion events — what to send, what each field does, and how events are stored and enriched. - [FAQ](https://docs.scanova.io/conversion-tracking/faq.md): Frequently asked questions about Scanova Conversion Tracking — setup, attribution, events, privacy, and billing. - [How Conversion Tracking Works](https://docs.scanova.io/conversion-tracking/how-it-works.md): Understand the full data flow from QR Code scan to conversion report — attribution model, session lifecycle, and event pipeline explained. - [What is Conversion Tracking?](https://docs.scanova.io/conversion-tracking/introduction.md): Measure what users do on your website after scanning a QR Code — page views, clicks, purchases, and custom events — all attributed back to the exact QR Code that drove the visit. - [Generate an API Key](https://docs.scanova.io/conversion-tracking/server/generate-api-key-dashboard.md): Create a site-scoped API key for server-side Conversion Tracking events from the Scanova dashboard. Keys are shown once — store them securely. - [Idempotency & Retries](https://docs.scanova.io/conversion-tracking/server/idempotency-retries.md): How to safely retry failed server event requests without creating duplicate conversions. Use a stable event_id and exponential backoff. - [Server-Side Events Overview](https://docs.scanova.io/conversion-tracking/server/overview.md): Send secure conversion events directly from your backend — purchases, sign-ups, leads — attributed to the QR Code scan that started the user journey. - [Send Server-Side Events](https://docs.scanova.io/conversion-tracking/server/send-events.md): Send purchase, sign-up, and lead conversion events from your backend to Scanova using the server events API. Code examples in cURL, Node.js, Python, and PHP. - [Verify & Debug Server Events](https://docs.scanova.io/conversion-tracking/server/verify.md): Confirm your server-side conversion events are being received, attributed correctly, and appearing in reports. - [Quick Start — Go Live in 5 Steps](https://docs.scanova.io/conversion-tracking/setup-guide.md): The fastest path to live QR Code conversion tracking. Create a site, install the snippet, verify events, and start measuring in under 10 minutes. - [Troubleshooting](https://docs.scanova.io/conversion-tracking/troubleshooting.md): Fix common Scanova Conversion Tracking issues — no events appearing, CORS errors, 403 domain errors, missing attribution, and duplicate events. - [API Integration](https://docs.scanova.io/development.md): Integrate with the Scanova API using HTTP requests in any programming language - [Code Examples](https://docs.scanova.io/essentials/code.md): Ready-to-use code samples for the Scanova API - [App Deep Link QR Code](https://docs.scanova.io/guides/category-components/categories/appDeepLink.md): Validate app deep link schema - [App Store Schema](https://docs.scanova.io/guides/category-components/categories/appStore.md): Validate App Store Schema - [Audio Category Schema](https://docs.scanova.io/guides/category-components/categories/audio.md): Validate Audio category - [Bitcoin category schema](https://docs.scanova.io/guides/category-components/categories/bitcoin.md): Static QR Category. Validate bitcoin address - [Business card category](https://docs.scanova.io/guides/category-components/categories/businessCard.md) - [Calendar category schema](https://docs.scanova.io/guides/category-components/categories/calendar.md): Static QR category. Validate calendar category - [Coupon category schema](https://docs.scanova.io/guides/category-components/categories/coupon.md): Used to validate data of coupon category - [Document category schema](https://docs.scanova.io/guides/category-components/categories/document.md): Used to validate data of document category. - [Dynamic Text category schema](https://docs.scanova.io/guides/category-components/categories/dynamicText.md): Used to validated dynamic test/rich text/custom page category - [Dynamicvcard](https://docs.scanova.io/guides/category-components/categories/dynamicVCard.md) - [Email QR Category](https://docs.scanova.io/guides/category-components/categories/email.md): Static QR Category. Validate Email category - [Event QR Category Schema](https://docs.scanova.io/guides/category-components/categories/event.md): Validate Event QR category - [Feedback category](https://docs.scanova.io/guides/category-components/categories/feedback.md) - [GS1 Category Wrapper Schema (data-wrapped)](https://docs.scanova.io/guides/category-components/categories/gs1.md) - [Image Category Schema](https://docs.scanova.io/guides/category-components/categories/image.md): Validate Image Category - [Map category schema](https://docs.scanova.io/guides/category-components/categories/map.md): Validate map category - [PayPal QR Category](https://docs.scanova.io/guides/category-components/categories/payPal.md): Static QR Category. Validate payPal category - [Phone Number Category Schema](https://docs.scanova.io/guides/category-components/categories/phoneNumber.md): Static QR Category. Validate phone number category - [Product category schema](https://docs.scanova.io/guides/category-components/categories/product.md): Validate product category - [Real Estate QR Code Schema](https://docs.scanova.io/guides/category-components/categories/realEstate.md): Schema for storing real estate-related QR code information - [Restaurant category](https://docs.scanova.io/guides/category-components/categories/restaurant.md) - [Social Media category schema](https://docs.scanova.io/guides/category-components/categories/sMedia.md): Validate social media category - [Simple Text Message category](https://docs.scanova.io/guides/category-components/categories/sms.md): Static QR Category. Simple SMS QR Category. - [Simple Text](https://docs.scanova.io/guides/category-components/categories/text.md): Static QR Category. Text category schema - [URL Category schema](https://docs.scanova.io/guides/category-components/categories/url.md): Used to validate data of URL category. - [Simple VCard category](https://docs.scanova.io/guides/category-components/categories/vCard.md): Static QR Category. Simple VCard Schema - [Wedding category](https://docs.scanova.io/guides/category-components/categories/wedding.md): Validate wedding category - [Wifi category](https://docs.scanova.io/guides/category-components/categories/wifi.md): Static QR category. Wifi QR Code. - [Base Button Schema](https://docs.scanova.io/guides/category-components/components/_base_button.md): Defines the base structure for all button components. This schema can be extended or customized to include additional fields for color, style, and tracking. - [Base Custom Form Component](https://docs.scanova.io/guides/category-components/components/_base_form.md): Defines a fully configurable Custom Form Component that allows collecting user input through dynamic question blocks. Each form can include multiple question types (text, choice, rating, upload, etc.) with optional formatting and styling controls. - [Base Map Component](https://docs.scanova.io/guides/category-components/components/_base_map.md): Defines the base structure for map integrations across Scanova categories. This component can be extended to include additional fields such as custom markers, labels, or overlays. - [Banner Images Component](https://docs.scanova.io/guides/category-components/components/banner_images.md): Defines the Banner Images Component used to attach up to three banner images within a category. Ensures all uploaded images meet supported URL formats and file extensions. - [Brand Info Schema](https://docs.scanova.io/guides/category-components/components/brand_info.md): Defines the brand information section used within the Restaurant QR Code category. Includes logo, banner image, title, and short brand description fields. - [Button component schema](https://docs.scanova.io/guides/category-components/components/button.md): Button Component Defines an interactive button used for navigation, communication, or conditional redirection within QR Code categories. Extends the Base Button Component with additional link and behavior properties. - [Company Branding](https://docs.scanova.io/guides/category-components/components/company_branding.md): Defines the Company Branding Component, which displays brand visuals such as a logo or title. Commonly used in Coupon and Social Media (sMedia) QR Code categories to establish brand identity. - [Conditional Redirection ](https://docs.scanova.io/guides/category-components/components/conditional_urls.md): Defines redirection conditions for the Website URL QR Code category. Enables dynamic URL redirects based on user attributes such as device type, operating system, country, or language. - [Custom Form Component](https://docs.scanova.io/guides/category-components/components/custom_form.md): Custom form component schema - [Custom Script Component](https://docs.scanova.io/guides/category-components/components/custom_script.md): Defines and validates custom scripts (inline or external) for QR Code landing pages. Allows developers to add custom functionalities such as analytics tracking, widgets, or event integrations. - [Description Box Component](https://docs.scanova.io/guides/category-components/components/description_box.md): Defines and validates the Description Box content displayed on QR Code landing pages. Commonly used to show detailed text blocks such as product information, event summaries, or promotional details. - [Design Info Component](https://docs.scanova.io/guides/category-components/components/design_info.md): Defines and validates the visual design configuration of a QR Code or landing page section. This component controls QR Code appearance, background colors, gradients, and layout alignment. - [Event Schedule Component](https://docs.scanova.io/guides/category-components/components/event_schedule.md): Defines the structure for event timing and scheduling information within a QR Code category. This component supports time zones, recurrence patterns, and calendar integration for event-based QR Codes. - [Event Tracking](https://docs.scanova.io/guides/category-components/components/event_tracking.md): Defines the configuration for tracking user interactions such as button clicks or engagement events on QR Code landing pages. Enables analytics and behavioral insights across multiple categories. - [Event Venue Component](https://docs.scanova.io/guides/category-components/components/event_venue.md): Defines the venue configuration for event-based QR Codes, supporting both physical and online events. This component enables detailed address information, joining options, and location display on maps. - [File Upload Schema](https://docs.scanova.io/guides/category-components/components/file.md): Defines the structure for handling file uploads within QR Code categories. This component allows attaching, validating, and linking files such as documents, images, or media through a customizable upload button. - [Form input fields](https://docs.scanova.io/guides/category-components/components/form_input.md): Defines input field types and configurations used within the Custom Form Component. Each field type provides its own structure for validation, display, and data capture. - [Logo Section Schema](https://docs.scanova.io/guides/category-components/components/logo_section.md): Defines the logo display configuration for the Feedback QR Code category. Used to render a brand or organization logo within the feedback form or thank-you page layout. - [Map Location Component](https://docs.scanova.io/guides/category-components/components/map.md): Extends the Base Map Component by adding an interactive button element. Commonly used for “Get Directions,” “View on Map,” or “Locate Us” functionality. - [Page Layout Component](https://docs.scanova.io/guides/category-components/components/page_layout.md): Defines the layout styling for a QR Code landing page, including background color and image configuration. Used across multiple categories to maintain consistent design and branding. - [Additional Page Settings](https://docs.scanova.io/guides/category-components/components/page_settings.md): Defines meta and branding properties for a QR Code landing page. These settings enhance SEO, sharing previews, and brand identity for each QR Code category. - [Page Title Component](https://docs.scanova.io/guides/category-components/components/page_title.md): Defines and validates the page title block displayed on QR Code landing pages. Commonly used across event, social, and wedding categories for consistent section headers. - [RSVP Component](https://docs.scanova.io/guides/category-components/components/rsvp.md): Defines the schema for RSVP (Respond to Invitation) functionality in QR Code landing pages. Enables invitees to confirm attendance, submit guest details, and send responses directly to the event organizer. - [RSVP Form component](https://docs.scanova.io/guides/category-components/components/rsvp_form.md): Defines the structure for questions within the RSVP flow. This component is referenced by the RSVP Component. - [Separator Component](https://docs.scanova.io/guides/category-components/components/separator.md): Defines a reusable visual divider for organizing content sections within landing pages. Commonly used in Wedding category designs for aesthetic separation between elements. - [Social Profile Component](https://docs.scanova.io/guides/category-components/components/social_profile.md): Defines social media links, contact details, or digital identity fields for QR Code landing pages. Commonly used in categories like Product, Restaurant, and Social Media QR Codes. - [Social Sharing Component](https://docs.scanova.io/guides/category-components/components/social_sharing_buttons.md): Enables visitors to share QR Code landing pages directly across social platforms or channels. Commonly used in Event, Product, and Coupon categories for audience engagement and reach expansion. - [Start Page Schema](https://docs.scanova.io/guides/category-components/components/start_page.md): Defines the structure for start or intro pages used in Feedback QR Codes. This schema specifies how the logo, title, description, and button appear on the first page of a feedback flow. - [Success Page Schema](https://docs.scanova.io/guides/category-components/components/success_page.md): Defines the structure for the success or completion screen displayed after form submissions or interactions — typically used in Feedback QR Codes and similar flows. - [Video Component](https://docs.scanova.io/guides/category-components/components/video.md): Defines the structure for embedding or referencing video content within a QR Code landing page. Supports both hosted (external) and uploaded videos with optional thumbnail previews. - [Scanova API Documentation](https://docs.scanova.io/index.md): Build powerful QR code solutions with the Scanova API - [Quickstart](https://docs.scanova.io/quickstart.md): Start building with the Scanova API in minutes ## OpenAPI Specs - [form](https://docs.scanova.io/api-reference/openapi/form.json) - [management](https://docs.scanova.io/api-reference/openapi/management.json) - [conversion-analytics](https://docs.scanova.io/api-reference/openapi/conversion-analytics.json) - [conversion-tracking](https://docs.scanova.io/api-reference/openapi/conversion-tracking.json) - [qr-code](https://docs.scanova.io/api-reference/openapi/qr-code.json) - [user-management](https://docs.scanova.io/api-reference/openapi/user-management.json) - [lead-list](https://docs.scanova.io/api-reference/openapi/lead-list.json) - [analytics](https://docs.scanova.io/api-reference/openapi/analytics.json) - [index](https://docs.scanova.io/api-reference/openapi/index.json) - [openapi](https://docs.scanova.io/api-reference/openapi.json)