Raportit

curl -X POST "https://getqr.com/api/v1/reports" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "scope": "selected",
    "qrIds": ["clw3n7t1x0002ab0d5mqe8pkr"],
    "period": "weekly",
    "format": "json",
    "timezone": "America/New_York"
  }'

curl -X POST "https://getqr.com/api/v1/reports" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "scope": "all", "period": "monthly", "format": "pdf", "locale": "de" }' \
  --output report.pdf

{
  "periodStart": "2026-08-10",
  "periodEnd": "2026-08-17",
  "qrs": [
    {
      "qrId": "clw3n7t1x0002ab0d5mqe8pkr",
      "name": "Landing page",
      "type": "website",
      "totalScans": 128,
      "uniqueScans": 96,
      "topGeography": "US",
      "topDevice": "Mobile",
      "topOs": "iOS",
      "topBrowser": "Safari"
    }
  ]
}

curl -X POST "https://getqr.com/api/v1/reports" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "scope": "selected",
    "qrIds": ["clw3n7t1x0002ab0d5mqe8pkr"],
    "period": "weekly",
    "format": "json",
    "timezone": "America/New_York"
  }'

curl -X POST "https://getqr.com/api/v1/reports" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "scope": "all", "period": "monthly", "format": "pdf", "locale": "de" }' \
  --output report.pdf

{
  "periodStart": "2026-08-10",
  "periodEnd": "2026-08-17",
  "qrs": [
    {
      "qrId": "clw3n7t1x0002ab0d5mqe8pkr",
      "name": "Landing page",
      "type": "website",
      "totalScans": 128,
      "uniqueScans": 96,
      "topGeography": "US",
      "topDevice": "Mobile",
      "topOs": "iOS",
      "topBrowser": "Safari"
    }
  ]
}

GetQR API on beetavaiheessa, ja se on käytettävissä valituissa työtiloissa. Yksityiskohdat voivat muuttua ennen yleistä julkaisua.

Raportit kokoavat skannaukset QR-koodeittain päättyneeltä päivältä, viikolta tai kuukaudelta. Vie raportti heti tai ajasta raportti, joka lähetetään sähköpostitse säännöllisesti.

Metodi	Polku	Kuvaus
`POST`	`/api/v1/reports`	Vie raportti
`GET`	`/api/v1/reports/schedules`	Listaa ajastetut raportit
`POST`	`/api/v1/reports/schedules`	Ajasta raportti
`PATCH`	`/api/v1/reports/schedules/{id}`	Päivitä ajastettu raportti
`DELETE`	`/api/v1/reports/schedules/{id}`	Poista ajastettu raportti

Otsakkeet

string

vaadittu

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

string

application/json. Pakollinen POST- ja PATCH-pyynnöissä.

Kattavuus

Sekä kertaluonteiset että ajastetut raportit ottavat kentän scope:

`scope`	Kattaa	`qrIds`
`all`	Työtilasi QR-koodit	Jätä pois
`selected`	Valitut QR-koodit	Yksi tai useampi tunnus
`single`	Täsmälleen yksi QR-koodi	Täsmälleen yksi tunnus

Raportissa on enintään 50 QR-koodia. Arvolla all nämä ovat viimeksi luodut aktiiviset QR-koodit; keskeytetyt koodit jätetään pois. Arvoilla selected ja single keskeytetyt koodit otetaan mukaan. QR-koodeilla, joilla ei ole lyhytlinkkiä, ei ole skannauksia, ja ne ohitetaan.

Jakso

Jakso on aina viimeisin päättynyt jakso, joten raportti ei koskaan sisällä kuluvan päivän keskeneräisiä tietoja. Sen rajat ovat keskiyöllä raportin aikavyöhykkeellä.

`period` tai `frequency`	Kattaa
`daily`	Edellinen päivä
`weekly`	Edellinen viikko maanantaista sunnuntaihin
`monthly`	Edellinen kalenterikuukausi

Vie raportti

POST /api/v1/reports Muodostaa raportin viimeisimmältä päättyneeltä jaksolta ja palauttaa sen vastauksessa.

string

vaadittu

all, selected tai single. Katso Kattavuus.

string

vaadittu

daily, weekly tai monthly. Katso Jakso.

string

vaadittu

json palauttaa raportin vastauksen rungossa. csv ja pdf palauttavat ladattavan tiedoston.

string[]

Mukaan otettavat QR-koodit. Pakollinen arvoille selected (yksi tai useampi tunnus) ja single (täsmälleen yksi tunnus). Jätä pois arvolla all.

string

oletus:"UTC"

IANA-aikavyöhyke, jonka mukaan jakson rajat kohdistetaan, esimerkiksi America/New_York. Tuntematon aikavyöhyke palauttaa 422.

string

oletus:"en"

PDF:n kieli, esimerkiksi en tai de. Tukematon arvo vaihtuu englanniksi. csv ja json ohittavat sen.

string

PDF:ssä näkyvä otsikko, enintään 40 merkkiä. csv ja json ohittavat sen.

JSON-vastaus

string

Jakson ensimmäinen päivä, YYYY-MM-DD.

string

Jakson jälkeinen ensimmäinen päivä, YYYY-MM-DD. Jakso päättyy tämän päivän alussa keskiyöllä.

object[]

Yksi merkintä QR-koodia kohti.

Näytä properties

string

QR-koodin tunnus.

string

QR-koodin nimi tai Untitled QR.

string

QR-koodin tyyppi, esimerkiksi website.

integer

Skannaukset jaksolla yhteensä.

integer

Yksilölliset skannaukset jaksolla.

string

Maakoodi, josta on eniten skannauksia, tai —, jos skannauksia ei ole.

string

Laite, jolla on eniten skannauksia, tai —.

string

Käyttöjärjestelmä, jolla on eniten skannauksia, tai —.

string

Selain, jolla on eniten skannauksia, tai —.

CSV- ja PDF-vastaukset

Runko on tiedosto. Content-Disposition nimeää sen jakson mukaan, esimerkiksi report-2026-08-10_2026-08-17.csv. CSV-tiedostossa on yksi rivi QR-koodia kohti, ja sen sarakkeet ovat QR ID, QR name, QR type, Total scans, Unique scans, Top geography, Top device, Top OS ja Top browser.

curl -X POST "https://getqr.com/api/v1/reports" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "scope": "selected",
    "qrIds": ["clw3n7t1x0002ab0d5mqe8pkr"],
    "period": "weekly",
    "format": "json",
    "timezone": "America/New_York"
  }'

curl -X POST "https://getqr.com/api/v1/reports" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "scope": "all", "period": "monthly", "format": "pdf", "locale": "de" }' \
  --output report.pdf

{
  "periodStart": "2026-08-10",
  "periodEnd": "2026-08-17",
  "qrs": [
    {
      "qrId": "clw3n7t1x0002ab0d5mqe8pkr",
      "name": "Landing page",
      "type": "website",
      "totalScans": 128,
      "uniqueScans": 96,
      "topGeography": "US",
      "topDevice": "Mobile",
      "topOs": "iOS",
      "topBrowser": "Safari"
    }
  ]
}

Ajastetun raportin objekti

Ajastettu raportti lähetetään sähköpostitse sen luoneelle tilille keskiyöllä raportin aikavyöhykkeellä.

string

Ajastetun raportin tunnus.

string | null

Nimi, joka näkyy sähköpostin aiheessa ja hallintapaneelissa.

string

daily, weekly tai monthly.

string

all, selected tai single.

string[] | null

QR-koodit, jotka raportti kattaa arvoilla selected ja single. null, jos tunnuksia ei lähetetty.

null

Aina null. Varattu.

boolean

Liitetäänkö sähköpostiin PDF.

string

active tai paused.

string

IANA-aikavyöhyke, jonka mukaan lähetysaika ja jakso kohdistetaan.

string

Sähköpostin ja PDF:n kieli.

string

Milloin seuraava sähköposti lähtee, ISO 8601: seuraava keskiyö (daily), seuraava maanantai (weekly) tai seuraavan kuun 1. päivä (monthly) raportin aikavyöhykkeellä.

string | null

Milloin viimeisin sähköposti lähetettiin, ISO 8601.

string

Luontipäivä, ISO 8601.

string

Viimeisimmän päivityksen päivä, ISO 8601.

Listaa ajastetut raportit

GET /api/v1/reports/schedules Palauttaa työtilasi ajastetut raportit, myös muiden jäsenten luomat, uusimmat ensin. Lista on sivutettu: katso Sivutus.

integer

oletus:"1"

Palautettava sivu, 1 tai suurempi.

integer

oletus:"100"

Tuloksia sivua kohti, 1–100.

curl "https://getqr.com/api/v1/reports/schedules?page=1&pageSize=100" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{
  "data": [
    {
      "id": "clx8f2k9a0001qk0c8vhd3xyz",
      "name": "Weekly campaign digest",
      "frequency": "weekly",
      "scope": "selected",
      "qrIds": ["clw3n7t1x0002ab0d5mqe8pkr", "clw3n7t1x0004ab0d9rzu2wfh"],
      "filters": null,
      "includePdf": true,
      "status": "active",
      "timezone": "America/New_York",
      "locale": "en",
      "nextRunAt": "2026-08-10T04:00:00.000Z",
      "lastRunAt": "2026-08-03T04:00:12.000Z",
      "createdAt": "2026-07-01T12:34:56.000Z",
      "updatedAt": "2026-07-28T09:12:00.000Z"
    }
  ],
  "pagination": { "page": 1, "pageSize": 100, "total": 1, "hasMore": false }
}

Ajasta raportti

POST /api/v1/reports/schedules Luo raportin, joka lähetetään sähköpostitse säännöllisesti. nextRunAt lasketaan toistuvuuden ja aikavyöhykkeen perusteella.

QR-koodi voi kuulua vain yhteen ajastettuun raporttiin kutakin toistuvuutta kohti. Päällekkäinen ajastus palauttaa 409 conflict.

Raportti, jonka kattavuus on all, menee päällekkäin kaikkien muiden saman toistuvuuden raporttien kanssa. Myös keskeytetyt raportit lasketaan.

string

vaadittu

Kuinka usein raportti lähetetään: daily, weekly tai monthly. Määrittää myös sen kattaman jakson. Katso Jakso.

string

vaadittu

all, selected tai single. Katso Kattavuus.

string

vaadittu

IANA-aikavyöhyke, jonka mukaan lähetysaika ja jakso kohdistetaan, esimerkiksi America/New_York. Tuntematon aikavyöhyke palauttaa 422.

string

vaadittu

Sähköpostin ja PDF:n kieli, esimerkiksi en tai de. Tukematon arvo vaihtuu englanniksi. PDF-tiedostot kielillä zh, ja, ko ja ar muodostetaan englanniksi.

string[]

Mukaan otettavat QR-koodit. Pakollinen arvoille selected (yksi tai useampi tunnus) ja single (täsmälleen yksi tunnus). Jokaisen tunnuksen on oltava työtilasi QR-koodi, muuten pyyntö palauttaa 404.

string

Nimi, joka näkyy sähköpostin aiheessa ja hallintapaneelissa, enintään 40 merkkiä.

boolean

oletus:"false"

Liitä sähköpostiin raportin PDF-versio.

curl -X POST "https://getqr.com/api/v1/reports/schedules" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Weekly campaign digest",
    "frequency": "weekly",
    "scope": "selected",
    "qrIds": ["clw3n7t1x0002ab0d5mqe8pkr"],
    "includePdf": true,
    "timezone": "America/New_York",
    "locale": "en"
  }'

{
  "id": "clx8f2k9a0001qk0c8vhd3xyz",
  "name": "Weekly campaign digest",
  "frequency": "weekly",
  "scope": "selected",
  "qrIds": ["clw3n7t1x0002ab0d5mqe8pkr"],
  "filters": null,
  "includePdf": true,
  "status": "active",
  "timezone": "America/New_York",
  "locale": "en",
  "nextRunAt": "2026-08-10T04:00:00.000Z",
  "lastRunAt": null,
  "createdAt": "2026-08-03T12:34:56.000Z",
  "updatedAt": "2026-08-03T12:34:56.000Z"
}

Päivitä ajastettu raportti

PATCH /api/v1/reports/schedules/{id} Muuttaa ajastettua raporttia tai keskeyttää ja jatkaa sitä. Lähetä vain ne kentät, joita haluat muuttaa, vähintään yksi. Toistuvuuden tai aikavyöhykkeen muuttaminen tai keskeytetyn raportin jatkaminen laskee nextRunAt-arvon uudelleen. Yksi raportti toistuvuutta kohti -sääntö on edelleen voimassa, joten päällekkäinen muutos palauttaa 409.

string

vaadittu

Ajastetun raportin tunnus. Ota se listauksen tai luonnin vastauksesta.

string

paused pysäyttää sähköpostit poistamatta ajastusta. active jatkaa niitä.

string

Nimi, enintään 40 merkkiä.

string

daily, weekly tai monthly.

string

all, selected tai single.

string[]

Mukaan otettavat QR-koodit. Jokaisen tunnuksen on oltava työtilasi QR-koodi.

boolean

Liitä sähköpostiin PDF.

string

IANA-aikavyöhyke.

string

Sähköpostin ja PDF:n kieli.

curl -X PATCH "https://getqr.com/api/v1/reports/schedules/clx8f2k9a0001qk0c8vhd3xyz" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Monthly campaign digest",
    "frequency": "monthly",
    "status": "active"
  }'

{
  "id": "clx8f2k9a0001qk0c8vhd3xyz",
  "name": "Monthly campaign digest",
  "frequency": "monthly",
  "scope": "selected",
  "qrIds": ["clw3n7t1x0002ab0d5mqe8pkr"],
  "filters": null,
  "includePdf": true,
  "status": "active",
  "timezone": "America/New_York",
  "locale": "en",
  "nextRunAt": "2026-09-01T04:00:00.000Z",
  "lastRunAt": "2026-08-03T04:00:12.000Z",
  "createdAt": "2026-07-01T12:34:56.000Z",
  "updatedAt": "2026-08-05T10:15:00.000Z"
}

Poista ajastettu raportti

DELETE /api/v1/reports/schedules/{id} Poistaa ajastuksen ja lopettaa kaikki tulevat sähköpostit.

Ajastetun raportin poistoa ei voi perua.

string

vaadittu

Ajastetun raportin tunnus.

curl -X DELETE "https://getqr.com/api/v1/reports/schedules/clx8f2k9a0001qk0c8vhd3xyz" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{ "id": "clx8f2k9a0001qk0c8vhd3xyz", "deleted": true }

Yleisiä ongelmia

404 raporttia vietäessä

Kattavuudella selected tai single mikään qrIds-tunnuksista ei vastannut työtilasi QR-koodia, jolla on lyhytlinkki. Tarkista tunnukset.

404 "QR not found." raporttia ajastettaessa

Jokin qrIds-tunnuksista ei ole työtilasi QR-koodi, tai se on poistettu. Tarkista tunnukset QR-koodien listauksella.

409 raporttia ajastettaessa

Jokin QR-koodeista kuuluu jo samantoistuvuiseen ajastettuun raporttiin, tai saman toistuvuuden raportti käyttää kattavuutta all. Muokkaa tai poista kyseinen raportti tai valitse eri toistuvuus.

404 "Scheduled report not found."

id ei vastaa työtilasi ajastettua raporttia. Ota se kohdasta Listaa ajastetut raportit.

Raportista puuttuvat tämän päivän skannaukset

Raportit kattavat vain viimeisimmän päättyneen jakson. Käytä Analytiikkaa reaaliaikaisiin lukuihin.

API

Otsakkeet

Kattavuus

Jakso

Vie raportti

JSON-vastaus

CSV- ja PDF-vastaukset

Ajastetun raportin objekti

Listaa ajastetut raportit

Ajasta raportti

Päivitä ajastettu raportti

Poista ajastettu raportti

Yleisiä ongelmia

Mitä seuraavaksi

Analytiikka

Ajastetut raportit sovelluksessa

Raporttien lukeminen

Virheet

​Otsakkeet

​Kattavuus

​Jakso

​Vie raportti

​JSON-vastaus

​CSV- ja PDF-vastaukset

​Ajastetun raportin objekti

​Listaa ajastetut raportit

​Ajasta raportti

​Päivitä ajastettu raportti

​Poista ajastettu raportti

​Yleisiä ongelmia

​Mitä seuraavaksi

Analytiikka

Ajastetut raportit sovelluksessa

Raporttien lukeminen

Virheet

Otsakkeet

Kattavuus

Jakso

Vie raportti

JSON-vastaus

CSV- ja PDF-vastaukset

Ajastetun raportin objekti

Listaa ajastetut raportit

Ajasta raportti

Päivitä ajastettu raportti

Poista ajastettu raportti

Yleisiä ongelmia

Mitä seuraavaksi