Przejdź do głównej treści
API GetQR jest w wersji beta i jest dostępne dla wybranych obszarów roboczych. Szczegóły mogą się zmienić przed ogólną premierą.
Pobieraj łączną liczbę skanowań i podziały według kraju, urządzenia, przeglądarki i innych wymiarów, dla pojedynczego kodu QR lub całego obszaru roboczego. Gotowe podsumowanie dla każdego kodu QR znajdziesz w sekcji Raporty.

Co oznaczają liczby

  • Skanowania. Każda liczba znajduje się w polu clicks. Skanowanie jest liczone za każdym razem, gdy ktoś otworzy krótki link kodu QR.
  • Unikalne skanowania. Z unique=true każdy odwiedzający jest liczony raz w danym zakresie dat.
  • Zakres danych. Liczby pochodzą z krótkiego linku kodu QR. Kod QR bez krótkiego linku nie ma skanowań do policzenia.
  • Historia. Analityki nie można zresetować przez API. Usunięcie kodu QR nie usuwa historycznych danych skanowań.

Nagłówki

string
wymagane
Bearer, a po nim Twój klucz API. Zobacz Uwierzytelnianie.

Parametry zapytania

Oba endpointy przyjmują te parametry. Wszystkie są opcjonalne.
string
domyślnie:"count"
Wymiar podziału. count zwraca sumę. Wszystkie wartości i kształt odpowiedzi dla każdej z nich opisuje sekcja Podziały.
string
domyślnie:"30d"
Predefiniowany zakres dat: 24h, 7d, 30d, 90d, 1y, mtd, qtd, ytd lub all. Zobacz Zakresy dat. Ignorowany, gdy wysyłasz start.
string
Początek niestandardowego zakresu, ISO 8601, np. 2026-08-01 lub 2026-08-01T00:00:00Z. Ma pierwszeństwo przed interval. Musi być wcześniejszy niż end.
string
Koniec niestandardowego zakresu, ISO 8601. Domyślnie koniec dzisiejszego dnia. Używany razem ze start lub interval=all, a przy pozostałych interwałach ignorowany.
string
domyślnie:"UTC"
Strefa czasowa IANA, według której wyrównywane są przedziały timeseries, np. America/New_York. Nieznana strefa czasowa zwraca 422.
boolean
domyślnie:"false"
true liczy unikalne skanowania zamiast łącznej liczby skanowań.
Możesz też wysyłać filtry wymiarów.

Zakresy dat

Dla niestandardowego zakresu wyślij start i opcjonalnie end. Zakresy do 2 dni mają przedziały godzinowe, zakresy dłuższe niż 180 dni mają przedziały miesięczne, a wszystkie pośrednie mają przedziały dzienne.

Filtry wymiarów

Zawęź wyniki do skanowań pasujących do filtra. Różne filtry są łączone przez AND. Gdy filtr przyjmuje kilka wartości, oddziel je przecinkami: wartości są łączone przez OR. Nieznany kod kraju lub kontynentu zwraca 422. Nazwy urządzeń, przeglądarek i systemów są dopasowywane z wielką pierwszą literą, więc mobile działa tak samo jak Mobile. Na przykład skanowania z USA lub Kanady na urządzeniach mobilnych: ?country=US,CA&device=Mobile.

Podziały

count zwraca obiekt. Każda inna wartość zwraca tablicę posortowaną według clicks od największej do najmniejszej (timeseries jest sortowane według czasu). Nieznana wartość groupBy zwraca 422 z listą prawidłowych wartości. Odpowiedź przy groupBy=count:
Odpowiedź przy groupBy=countries:

Analityka kodu QR

GET /api/v1/qrs/{qrId}/analytics Zwraca statystyki skanowań jednego kodu QR, ograniczone do jego krótkiego linku. Przyjmuje opisane wyżej parametry zapytania i filtry wymiarów.
string
wymagane
ID kodu QR. Weź je z odpowiedzi listy lub tworzenia w Kodach QR.

Analityka obszaru roboczego

GET /api/v1/analytics Zwraca statystyki skanowań wszystkich kodów QR w Twoim obszarze roboczym. Przyjmuje opisane wyżej parametry zapytania i filtry wymiarów oraz poniższe parametry zawężające.
string
Razem z key ogranicza wyniki do krótkiego linku w tej domenie, np. getqr.sh. Domena musi należeć do Twojego obszaru roboczego.
string
Slug krótkiego linku, np. x7Kd2p1. Używaj go razem z domain. Oba znajdziesz w obiekcie kodu QR.
string
Typy kodów QR do uwzględnienia, oddzielone przecinkami: website, pdf, image, video, whatsapp, social, wifi, app, feedback, vcard, sms, payment, location, multilink, email lub event. Zobacz Typy kodów QR.

Typowe problemy

W Twoim obszarze roboczym nie istnieje krótki link z tą domeną i slugiem. Skopiuj domain i key z obiektu kodu QR.
Ta wartość nie jest obsługiwana. Komunikat błędu podaje nazwę parametru i listę prawidłowych wartości.
Sprawdź, czy używasz tego samego zakresu dat i strefy czasowej oraz czy liczysz unikalne skanowania (unique=true), czy łączną liczbę skanowań.

Co dalej

Raporty

Kody QR

Analityka w aplikacji

Limity żądań