Skip to main content
POST
Get QR Code Analytics

Description

This endpoint provides comprehensive analytics for one or more QR codes in your account.
You can query by:
  • QR IDs (specific QR codes), or
  • Tags (group of QR codes with the same tag).
It supports a variety of analytics types — such as scans by date, device, browser, geography, and more — allowing you to build dashboards and reports programmatically.

Query Parameters

Supported type Values

Request Body

Examples

Get QR Code Analytics by QR ID

Get Analytics by Tags

Get Multiple QR Codes Analytics

Get All Analytics Types

Exclude Bot Scans

Response Structure

Success Response (200 OK)

The response structure varies based on the type query parameter. Response keys depend on the requested analytics types.

Complete Analytics Response (all types requested)

Count Analytics Only

Device, OS, and Browser Analytics

Analytics with Bot Scans Excluded (exclude_bot_scan=true)

When exclude_bot_scan=true is passed, all aggregations reflect human traffic only and the response includes a bot_scans summary:

Response Schema

Each analytics type returns a separate structure.

Use Cases

  • 📈 Build custom QR code analytics dashboards
  • 🗺️ Analyze user scan geography and device trends
  • ⏰ Study time-based scan activity
  • 🧭 Track campaign performance by tags or QR IDs
  • 🧮 Export scan data summaries for internal BI systems

Integration Examples

JavaScript - Get QR Code Analytics

Python - Get QR Code Analytics

PHP - Get QR Code Analytics

Analytics data is available for the last 2 years. For longer historical data, use the export endpoint to download data for offline analysis.
Large date ranges may result in slower response times. Consider breaking down requests into smaller date ranges for better performance.

Authorizations

Authorization
string
header
required

API key authentication. Enter your API key directly in the Authorization header.

Query Parameters

type
enum<string>

Analytics type(s) to retrieve. Multiple values can be comma-separated.

Available options:
count,
qr,
device,
os,
browser,
date,
handset,
geography,
geo_location
from
string<date>
required

Start date for analytics data (inclusive). Format: YYYY-MM-DD

to
string<date>
required

End date for analytics data (inclusive). Format: YYYY-MM-DD. Defaults to current date.

Body

application/json
filter_by
enum<string>
required

Filter by QR code ID or tags

Available options:
qrid,
tags
Example:

"qrid"

q
string[]
required

Array of QR code IDs (if filter_by is 'qrid') or tags (if filter_by is 'tags')

Example:

Response

Analytics data retrieved successfully

Analytics data response containing various types of analytics based on the requested fields. Response keys depend on the 'type' query parameter. Available analytics types: qr, count, device, os, browser, date, handset, geography, geo_location, age, day_time.