---
title: "Scan analytics for one QR"
method: GET
path: "/api/v1/qrs/{id}/analytics"
tags: ["Analytics"]
---

# Scan analytics for one QR

`GET /api/v1/qrs/{id}/analytics`

## Request

- Base URL: `https://qrlia.dev.castlesoft.eu`
- URL: `https://qrlia.dev.castlesoft.eu/api/v1/qrs/{id}/analytics`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `qrc_session`

## Path parameters

- `id` string, uuid, required

## Query parameters

- `days` integer: Look-back days; default 30, capped by the plan's analytics history.
- `includeBots` 'true' | 'false': Include link previews, mail scanners and scripts. Default false.

## Response `200`

Analytics

- ScanAnalytics
  - `range` object, required
    - `days` number, required
    - `maxDays` number, required
    - `requestedDays` number, required
    - `since` string, required
    - `until` string, required
  - `scope` object, required
    - `qrId` string, nullable, required
    - `companyId` string, nullable, required
  - `totals` object, required
    - `scans` number, required
    - `uniqueScans` number, required
    - `scansToday` number, required
    - `activeDays` number, required
    - `qrCodes` number, required
    - `botScans` number, required
  - `includesBots` boolean, required
  - `daily` object[], required
    - `day` string, required
    - `scans` number, required
    - `uniqueScans` number, required
  - `topQrs` object[], required
    - `id` string, required
    - `label` string, required
    - `type` string, required
    - `scans` number, required
  - `byCountry` object[], required
    - `value` string, nullable, required
    - `scans` number, required
  - `byCity` object[], required
    - `value` string, nullable, required
    - `scans` number, required
  - `byOs` object[], required
    - `value` string, nullable, required
    - `scans` number, required
  - `byDevice` object[], required
    - `value` string, nullable, required
    - `scans` number, required
  - `byReferrer` object[], required
    - `value` string, nullable, required
    - `scans` number, required
  - `insights` object, required: False on plans without scan insights (Free): only totals and topQrs are filled.
    - `included` boolean, required
    - `upgradeUrl` string, nullable, required

## Other responses

- `400`: Validation failed
- `401`: Authentication required
- `403`: Forbidden
- `404`: Not found
- `409`: Conflict
- `500`: Internal

---

[API](https://skmtc.dev/qrlia/apis/qrlia-api.md) · [All operations](https://skmtc.dev/qrlia/apis/qrlia-api/llms.txt) · [OpenAPI document](https://skmtc.dev/qrlia/apis/qrlia-api/revisions/01c5dd6002ab?raw)