Перейти до основного вмісту
API GetQR перебуває в бета-версії та доступний для окремих робочих просторів. До загального релізу деталі можуть змінитися.
Отримуйте загальну кількість сканувань і розбивки за країною, пристроєм, браузером та іншими вимірами — для одного 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
Slug короткого посилання, наприклад x7Kd2p1. Використовуйте його разом із domain. Обидва значення є в об’єкті QR-коду.
string
Типи QR-кодів через кому: website, pdf, image, video, whatsapp, social, wifi, app, feedback, vcard, sms, payment, location, multilink, email або event. Див. Дані QR-коду за типами.

Поширені проблеми

У вашому робочому просторі немає короткого посилання з таким доменом і slug. Скопіюйте domain і key з об’єкта QR-коду.
Значення не підтримується. Повідомлення про помилку називає параметр і перелічує допустимі значення.
Перевірте, що ви використовуєте той самий діапазон дат і часовий пояс, і чи рахуєте ви унікальні сканування (unique=true) або загальну кількість.

Що далі

Звіти

QR-коди

Аналітика в застосунку

Обмеження частоти запитів