Перейти к основному содержанию
GetQR API находится в бета-версии и доступен для отдельных рабочих пространств. До общего релиза детали могут измениться.
Получайте общее число сканирований и разбивки по странам, устройствам, браузерам и другим измерениям — для одного QR-кода или по всему рабочему пространству. Готовую сводку по каждому QR-коду см. в разделе Отчёты.

Что означают числа

  • Сканирования. Все значения находятся в поле clicks. Сканирование засчитывается каждый раз, когда кто-то открывает короткую ссылку QR-кода.
  • Уникальные сканирования. С unique=true каждый посетитель учитывается один раз за диапазон дат.
  • Охват. Числа берутся из короткой ссылки QR-кода. У QR-кода без короткой ссылки нет сканирований для подсчёта.
  • История. Аналитику нельзя сбросить через API. Удаление QR-кода не стирает историю его сканирований.

Заголовки

string
обязательно
Bearer и ваш API-ключ. См. Аутентификация.

Параметры запроса

Оба эндпоинта принимают эти параметры. Все они необязательны.
string
по умолчанию:"count"
Измерение разбивки. count возвращает общее число. Все значения и структуру ответа для каждого см. в разделе Разбивки.
string
по умолчанию:"30d"
Готовый диапазон дат: 24h, 7d, 30d, 90d, 1y, mtd, qtd, ytd или all. См. Диапазоны дат. Игнорируется, если передан start.
string
Начало своего диапазона в ISO 8601, например 2026-08-01 или 2026-08-01T00:00:00Z. Имеет приоритет над interval. Должно быть раньше end.
string
Конец своего диапазона в ISO 8601. По умолчанию — конец сегодняшнего дня. Используется вместе со start или interval=all и игнорируется с другими интервалами.
string
по умолчанию:"UTC"
Часовой пояс IANA для выравнивания интервалов timeseries, например America/New_York. Неизвестный часовой пояс возвращает 422.
boolean
по умолчанию:"false"
true считает уникальные сканирования вместо общего числа сканирований.
Также можно передавать фильтры по измерениям.

Диапазоны дат

Для своего диапазона передайте start и при необходимости end. Диапазоны до 2 дней разбиваются по часам, диапазоны больше 180 дней — по месяцам, всё, что между ними, — по дням.

Фильтры по измерениям

Ограничьте результаты сканированиями, которые подходят под фильтр. Разные фильтры объединяются через AND. Если фильтр принимает несколько значений, разделяйте их запятыми: значения объединяются через OR. Неизвестный код страны или континента возвращает 422. Названия устройств, браузеров и ОС сравниваются с заглавной первой буквой, поэтому mobile работает так же, как Mobile. Например, сканирования из США или Канады с мобильных устройств: ?country=US,CA&device=Mobile.

Разбивки

count возвращает объект. Все остальные значения возвращают массив, отсортированный по clicks от большего к меньшему (timeseries сортируется по времени). Неизвестное значение groupBy возвращает 422 со списком допустимых значений. Ответ при groupBy=count:
Ответ при groupBy=countries:

Аналитика QR-кода

GET /api/v1/qrs/{qrId}/analytics Возвращает статистику сканирований одного QR-кода по его короткой ссылке. Принимает описанные выше параметры запроса и фильтры по измерениям.
string
обязательно
ID QR-кода. Возьмите его из ответа на запрос списка или создания QR-кодов.

Аналитика рабочего пространства

GET /api/v1/analytics Возвращает статистику сканирований по всем QR-кодам вашего рабочего пространства. Принимает описанные выше параметры запроса и фильтры по измерениям, а также эти параметры для ограничения выборки.
string
Вместе с key ограничивает результаты короткой ссылкой с этим доменом, например getqr.sh. Домен должен принадлежать вашему рабочему пространству.
string
Слаг короткой ссылки, например x7Kd2p1. Используйте вместе с domain. Оба значения есть в объекте QR-кода.
string
Типы QR-кодов через запятую: website, pdf, image, video, whatsapp, social, wifi, app, feedback, vcard, sms, payment, location, multilink, email или event. См. Типы QR-кодов.

Частые проблемы

В вашем рабочем пространстве нет короткой ссылки с таким доменом и слагом. Скопируйте domain и key из объекта QR-кода.
Значение не поддерживается. Сообщение об ошибке называет параметр и перечисляет допустимые значения.
Проверьте, что используете тот же диапазон дат и часовой пояс, и что считаете: уникальные сканирования (unique=true) или все.

Что дальше

Отчёты

QR-коды

Аналитика в приложении

Ограничения частоты запросов