Pāriet uz galveno saturu
GetQR API ir beta versijā un pieejams atlasītām darbvietām. Līdz vispārējai izlaišanai detaļas var mainīties.
Iegūstiet skenējumu kopsummas un sadalījumus pa valstīm, ierīcēm, pārlūkprogrammām un citiem rādītājiem vienam QR kodam vai visai darbvietai. Gatavu kopsavilkumu par katru QR kodu skatiet sadaļā Atskaites.

Ko nozīmē skaitļi

  • Skenējumi. Katrs skaits ir laukā clicks. Skenējums tiek ieskaitīts katru reizi, kad kāds atver QR koda īso saiti.
  • Unikālie skenējumi. Ar unique=true katrs apmeklētājs datumu diapazonā tiek ieskaitīts vienu reizi.
  • Tvērums. Skaitļi tiek iegūti no QR koda īsās saites. QR kodam bez īsās saites nav skenējumu, ko skaitīt.
  • Vēsture. Analītiku nevar atiestatīt ar API. QR koda dzēšana neizdzēš tā vēsturiskos skenējumu datus.

Galvenes

string
obligāts
Bearer, kam seko jūsu API atslēga. Skatiet Autentifikācija.

Vaicājuma parametri

Abi galapunkti pieņem šos parametrus. Neviens no tiem nav obligāts.
string
noklusējums:"count"
Sadalījuma dimensija. count atgriež kopsummu. Visas vērtības un to atbilžu formu skatiet sadaļā Sadalījumi.
string
noklusējums:"30d"
Iepriekš iestatīts datumu diapazons: 24h, 7d, 30d, 90d, 1y, mtd, qtd, ytd vai all. Skatiet Datumu diapazoni. Tiek ignorēts, ja sūtāt start.
string
Pielāgota diapazona sākums, ISO 8601, piemēram, 2026-08-01 vai 2026-08-01T00:00:00Z. Tam ir prioritāte pār interval. Jābūt agrākam par end.
string
Pielāgota diapazona beigas, ISO 8601. Noklusējums ir šodienas beigas. Tiek izmantots kopā ar start vai interval=all un ignorēts ar citiem intervāliem.
string
noklusējums:"UTC"
IANA laika josla timeseries intervālu izlīdzināšanai, piemēram, America/New_York. Nezināma laika josla atgriež 422.
boolean
noklusējums:"false"
true skaita unikālos skenējumus kopējo skenējumu vietā.
Varat sūtīt arī dimensiju filtrus.

Datumu diapazoni

Pielāgotam diapazonam sūtiet start un pēc izvēles end. Diapazoni līdz 2 dienām izmanto stundu intervālus, diapazoni virs 180 dienām — mēnešu intervālus, bet viss starp tiem — dienu intervālus.

Dimensiju filtri

Sašauriniet rezultātus līdz skenējumiem, kas atbilst filtram. Dažādi filtri tiek apvienoti ar AND. Ja filtrs pieņem vairākas vērtības, atdaliet tās ar komatiem: vērtības tiek apvienotas ar OR. Nezināms valsts vai kontinenta kods atgriež 422. Ierīču, pārlūkprogrammu un OS nosaukumi tiek salīdzināti ar lielo sākumburtu, tāpēc mobile darbojas tāpat kā Mobile. Piemēram, skenējumi no ASV vai Kanādas mobilajās ierīcēs: ?country=US,CA&device=Mobile.

Sadalījumi

count atgriež objektu. Visas pārējās vērtības atgriež masīvu, kas sakārtots pēc clicks no lielākā uz mazāko (timeseries ir sakārtots pēc laika). Nezināms groupBy atgriež 422 ar derīgo vērtību sarakstu. Atbilde, kad groupBy=count:
Atbilde, kad groupBy=countries:

QR koda analītikas iegūšana

GET /api/v1/qrs/{qrId}/analytics Atgriež skenēšanas statistiku vienam QR kodam, ierobežotu ar tā īso saiti. Pieņem iepriekš aprakstītos vaicājuma parametrus un dimensiju filtrus.
string
obligāts
QR koda ID. Ņemiet to no QR kodu saraksta vai izveides atbildes.

Darbvietas analītikas iegūšana

GET /api/v1/analytics Atgriež skenēšanas statistiku visiem jūsu darbvietas QR kodiem. Pieņem iepriekš aprakstītos vaicājuma parametrus un dimensiju filtrus, kā arī šos tvēruma parametrus.
string
Kopā ar key ierobežo rezultātus līdz īsajai saitei ar šo domēnu, piemēram, getqr.sh. Domēnam jāpieder jūsu darbvietai.
string
Īsās saites slug, piemēram, x7Kd2p1. Izmantojiet to kopā ar domain. Abi ir atrodami QR koda objektā.
string
Ar komatiem atdalīti iekļaujamie QR kodu veidi: website, pdf, image, video, whatsapp, social, wifi, app, feedback, vcard, sms, payment, location, multilink, email vai event. Skatiet QR kodu veidi.

Biežākās problēmas

Jūsu darbvietā nav īsās saites ar šādu domēnu un slug. Nokopējiet domain un key no QR koda objekta.
Vērtība netiek atbalstīta. Kļūdas ziņojumā norādīts parametrs un uzskaitītas derīgās vērtības.
Pārbaudiet, vai izmantojat to pašu datumu diapazonu un laika joslu un vai skaitāt unikālos skenējumus (unique=true) vai kopējos skenējumus.

Kas tālāk

Atskaites

QR kodi

Analītika lietotnē

Pieprasījumu ierobežojumi