Shared QR analytics summary

GET

/api/share/{token}/sites/{id}/qr-codes/{qrID}/summary

curl --request GET \
  --url https://app.hitkeep.com/api/share/example/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/qr-codes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/summary

Returns one QR code’s analytics through an existing site share link.

Parameters

Path Parameters

token

required

string

id

required

string format: uuid

qrID

required

string format: uuid

Query Parameters

from

string format: date-time

to

string format: date-time

Responses

200

QR summary

Media type application/json

object

open_count

integer

pageviews

integer

qr_code

object

archived_at

string format: date-time

created_at

string format: date-time

created_by

string format: uuid

custom_params

object

key

additional properties

string

destination_url

string format: uri

has_asset

boolean

id

string format: uuid

name

string

redirect_url

Dynamic HitKeep redirect URL to encode in printed QR assets.

string format: uri

site_id

string format: uuid

style

object

key

additional properties

any

token_hint

string

updated_at

string format: date-time

utm_campaign

string

utm_content

string

utm_medium

string

utm_source

string

utm_term

string

top_countries

Array<object>

object

name

string

value

integer

top_devices

Array<object>

object

name

string

value

integer

top_pages

Array<object>

object

name

string

value

integer

top_referrers

Array<object>

object

name

string

value

integer

visitors

integer

Example ^generated

{
  "open_count": 1,
  "pageviews": 1,
  "qr_code": {
    "archived_at": "2026-04-15T12:00:00Z",
    "created_at": "2026-04-15T12:00:00Z",
    "created_by": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "custom_params": {
      "additionalProperty": "example"
    },
    "destination_url": "https://example.com",
    "has_asset": true,
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "name": "example",
    "redirect_url": "https://example.com",
    "site_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "style": {},
    "token_hint": "example",
    "updated_at": "2026-04-15T12:00:00Z",
    "utm_campaign": "example",
    "utm_content": "example",
    "utm_medium": "example",
    "utm_source": "example",
    "utm_term": "example"
  },
  "top_countries": [
    {
      "name": "example",
      "value": 1
    }
  ],
  "top_devices": [
    {
      "name": "example",
      "value": 1
    }
  ],
  "top_pages": [
    {
      "name": "example",
      "value": 1
    }
  ],
  "top_referrers": [
    {
      "name": "example",
      "value": 1
    }
  ],
  "visitors": 1
}