Siirry pääsisältöön
GetQR API on beetavaiheessa, ja se on käytettävissä valituissa työtiloissa. Yksityiskohdat voivat muuttua ennen yleistä julkaisua.
Hae skannausten kokonaismäärät ja erittelyt maittain, laitteittain, selaimittain ja muilla tavoin yhdelle QR-koodille tai koko työtilallesi. Valmis QR-koodikohtainen yhteenveto on kohdassa Raportit.

Mitä luvut tarkoittavat

  • Skannaukset. Jokainen määrä on kentässä clicks. Skannaus lasketaan aina, kun joku avaa QR-koodin lyhytlinkin.
  • Yksilölliset skannaukset. Parametrilla unique=true kukin kävijä lasketaan aikavälillä kerran.
  • Rajaus. Luvut tulevat QR-koodin lyhytlinkistä. QR-koodilla, jolla ei ole lyhytlinkkiä, ei ole laskettavia skannauksia.
  • Historia. Analytiikkaa ei voi nollata API:n kautta. QR-koodin poistaminen ei poista sen skannaushistoriaa.

Otsakkeet

string
vaadittu
Bearer ja sen perässä API-avaimesi. Katso Todennus.

Kyselyparametrit

Molemmat päätepisteet ottavat nämä parametrit. Kaikki ovat valinnaisia.
string
oletus:"count"
Erittelyulottuvuus. count palauttaa kokonaismäärän. Kaikki arvot ja niiden vastausten rakenne ovat kohdassa Erittelyt.
string
oletus:"30d"
Esimääritetty aikaväli: 24h, 7d, 30d, 90d, 1y, mtd, qtd, ytd tai all. Katso Aikavälit. Ohitetaan, kun lähetät parametrin start.
string
Mukautetun välin alku, ISO 8601, esimerkiksi 2026-08-01 tai 2026-08-01T00:00:00Z. Ohittaa parametrin interval. On oltava aiempi kuin end.
string
Mukautetun välin loppu, ISO 8601. Oletus on kuluvan päivän loppu. Käytetään yhdessä parametrin start tai arvon interval=all kanssa, ja muiden aikavälien kanssa se ohitetaan.
string
oletus:"UTC"
IANA-aikavyöhyke, jonka mukaan timeseries-jaksot kohdistetaan, esimerkiksi America/New_York. Tuntematon aikavyöhyke palauttaa 422.
boolean
oletus:"false"
true laskee yksilölliset skannaukset kaikkien skannausten sijaan.
Voit lähettää myös ulottuvuussuodattimia.

Aikavälit

Lähetä mukautettua aikaväliä varten start ja halutessasi end. Enintään 2 päivän välit käyttävät tuntijaksoja, yli 180 päivän välit kuukausijaksoja ja kaikki siltä väliltä päiväjaksoja.

Ulottuvuussuodattimet

Rajaa tulokset skannauksiin, jotka vastaavat suodatinta. Eri suodattimet yhdistetään AND-ehdolla. Kun suodatin ottaa useita arvoja, erottele ne pilkuilla: arvot yhdistetään OR-ehdolla. Tuntematon maa- tai maanosakoodi palauttaa 422. Laitteiden, selainten ja käyttöjärjestelmien nimet täsmätään isolla alkukirjaimella, joten mobile toimii kuten Mobile. Esimerkiksi skannaukset Yhdysvalloista tai Kanadasta mobiililaitteilla: ?country=US,CA&device=Mobile.

Erittelyt

count palauttaa objektin. Kaikki muut arvot palauttavat taulukon, joka on lajiteltu clicks-arvon mukaan suurimmasta pienimpään (timeseries on lajiteltu ajan mukaan). Tuntematon groupBy palauttaa 422 ja luettelon kelvollisista arvoista. Vastaus, kun groupBy=count:
Vastaus, kun groupBy=countries:

Hae QR-koodin analytiikka

GET /api/v1/qrs/{qrId}/analytics Palauttaa yhden QR-koodin skannaustilastot rajattuna sen lyhytlinkkiin. Ottaa yllä kuvatut kyselyparametrit ja ulottuvuussuodattimet.
string
vaadittu
QR-koodin tunnus. Ota se QR-koodien listauksen tai luonnin vastauksesta.

Hae työtilan analytiikka

GET /api/v1/analytics Palauttaa skannaustilastot kaikista työtilasi QR-koodeista. Ottaa yllä kuvatut kyselyparametrit ja ulottuvuussuodattimet sekä nämä rajausparametrit.
string
Yhdessä parametrin key kanssa rajaa tulokset lyhytlinkkiin, jolla on tämä verkkotunnus, esimerkiksi getqr.sh. Verkkotunnuksen on kuuluttava työtilaasi.
string
Lyhytlinkin slug, esimerkiksi x7Kd2p1. Käytä sitä yhdessä parametrin domain kanssa. Molemmat löytyvät QR-koodiobjektista.
string
Pilkuilla erotellut mukaan otettavat QR-koodityypit: website, pdf, image, video, whatsapp, social, wifi, app, feedback, vcard, sms, payment, location, multilink, email tai event. Katso QR-tyypit.

Yleisiä ongelmia

Työtilassasi ei ole lyhytlinkkiä, jolla on tämä verkkotunnus ja slug. Kopioi domain ja key QR-koodiobjektista.
Arvoa ei tueta. Virheviesti nimeää parametrin ja luettelee kelvolliset arvot.
Tarkista, että käytät samaa aikaväliä ja aikavyöhykettä ja lasketko yksilölliset skannaukset (unique=true) vai kaikki skannaukset.

Mitä seuraavaksi

Raportit

QR-koodit

Analytiikka sovelluksessa

Käyttörajoitukset