Berichte

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"
    }
  ]
}

Die GetQR API befindet sich in der Beta-Phase und steht ausgewählten Workspaces zur Verfügung. Details können sich bis zur allgemeinen Veröffentlichung noch ändern.

Berichte fassen die Scans pro QR-Code für einen abgeschlossenen Tag, eine Woche oder einen Monat zusammen. Exportieren Sie einen Bericht sofort, oder planen Sie einen Bericht, der regelmäßig per E-Mail verschickt wird.

Methode	Pfad	Beschreibung
`POST`	`/api/v1/reports`	Bericht exportieren
`GET`	`/api/v1/reports/schedules`	Geplante Berichte auflisten
`POST`	`/api/v1/reports/schedules`	Bericht planen
`PATCH`	`/api/v1/reports/schedules/{id}`	Geplanten Bericht aktualisieren
`DELETE`	`/api/v1/reports/schedules/{id}`	Geplanten Bericht löschen

string

erforderlich

Bearer gefolgt von Ihrem API-Schlüssel. Siehe Authentifizierung.

string

application/json. Erforderlich bei POST- und PATCH-Anfragen.

Umfang

Einmalige und geplante Berichte erwarten beide einen scope:

`scope`	Umfasst	`qrIds`
`all`	Die QR-Codes in Ihrem Workspace	Weglassen
`selected`	Eine ausgewählte Gruppe von QR-Codes	Eine oder mehrere IDs
`single`	Genau einen QR-Code	Genau eine ID

Ein Bericht listet höchstens 50 QR-Codes. Bei all sind das die zuletzt erstellten aktiven QR-Codes, pausierte Codes fehlen. Bei selected und single sind pausierte Codes enthalten. QR-Codes ohne Kurzlink haben keine Scans und werden übersprungen.

Zeitraum

Der Zeitraum ist immer der zuletzt abgeschlossene, sodass ein Bericht nie die unvollständigen Daten von heute enthält. Seine Grenzen liegen um Mitternacht in der Zeitzone des Berichts.

`period` oder `frequency`	Umfasst
`daily`	Den Vortag
`weekly`	Die Vorwoche, Montag bis Sonntag
`monthly`	Den vorigen Kalendermonat

Bericht exportieren

POST /api/v1/reports Erstellt einen Bericht für den zuletzt abgeschlossenen Zeitraum und liefert ihn in der Antwort.

string

erforderlich

all, selected oder single. Siehe Umfang.

string

erforderlich

daily, weekly oder monthly. Siehe Zeitraum.

string

erforderlich

json liefert den Bericht im Antwort-Body. csv und pdf liefern einen Datei-Download.

string[]

Einzubeziehende QR-Codes. Erforderlich bei selected (eine oder mehrere IDs) und single (genau eine ID). Bei all weglassen.

string

Standard:"UTC"

IANA-Zeitzone, an der die Grenzen des Zeitraums ausgerichtet werden, zum Beispiel America/New_York. Eine unbekannte Zeitzone liefert 422.

string

Standard:"en"

Sprache des PDFs, zum Beispiel en oder de. Bei einem nicht unterstützten Wert wird Englisch verwendet. Wird von csv und json ignoriert.

string

Titel auf dem PDF, bis zu 40 Zeichen. Wird von csv und json ignoriert.

JSON-Antwort

string

Erster Tag des Zeitraums, YYYY-MM-DD.

string

Erster Tag nach dem Zeitraum, YYYY-MM-DD. Der Zeitraum endet um Mitternacht zu Beginn dieses Tages.

object[]

Ein Eintrag pro QR-Code.

Anzeigen properties

string

ID des QR-Codes.

string

Titel des QR-Codes oder Untitled QR.

string

Typ des QR-Codes, zum Beispiel website.

integer

Alle Scans im Zeitraum.

integer

Eindeutige Scans im Zeitraum.

string

Ländercode mit den meisten Scans oder — ohne Scans.

string

Gerät mit den meisten Scans oder —.

string

Betriebssystem mit den meisten Scans oder —.

string

Browser mit den meisten Scans oder —.

CSV- und PDF-Antworten

Der Body ist die Datei. Content-Disposition benennt sie nach dem Zeitraum, zum Beispiel report-2026-08-10_2026-08-17.csv. Die CSV-Datei hat eine Zeile pro QR-Code mit den Spalten QR ID, QR name, QR type, Total scans, Unique scans, Top geography, Top device, Top OS und 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"
    }
  ]
}

Das Objekt des geplanten Berichts

Ein geplanter Bericht wird um Mitternacht in seiner Zeitzone per E-Mail an das Konto geschickt, das ihn erstellt hat.

string

ID des geplanten Berichts.

string | null

Bezeichnung, die im Betreff der E-Mail und im Dashboard angezeigt wird.

string

daily, weekly oder monthly.

string

all, selected oder single.

string[] | null

QR-Codes, die der Bericht bei den Umfängen selected und single abdeckt. null, wenn keine IDs gesendet wurden.

null

Immer null. Reserviert.

boolean

Ob der E-Mail ein PDF angehängt wird.

string

active oder paused.

string

IANA-Zeitzone, an der Versandzeit und Zeitraum ausgerichtet werden.

string

Sprache der E-Mail und des PDFs.

string

Fälligkeit der nächsten E-Mail, ISO 8601: die nächste Mitternacht (daily), der nächste Montag (weekly) oder der 1. des nächsten Monats (monthly), jeweils in der Zeitzone des Berichts.

string | null

Versandzeitpunkt der letzten E-Mail, ISO 8601.

string

Erstellungsdatum, ISO 8601.

string

Datum der letzten Aktualisierung, ISO 8601.

Geplante Berichte auflisten

GET /api/v1/reports/schedules Liefert die geplanten Berichte Ihres Workspace, auch die von anderen Mitgliedern erstellten, die neuesten zuerst. Die Liste ist paginiert: siehe Paginierung.

integer

Standard:"1"

Zurückzugebende Seite, 1 oder höher.

integer

Standard:"100"

Ergebnisse pro Seite, 1 bis 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 }
}

Bericht planen

POST /api/v1/reports/schedules Erstellt einen Bericht, der regelmäßig per E-Mail verschickt wird. nextRunAt wird aus Häufigkeit und Zeitzone berechnet.

Ein QR-Code kann pro Häufigkeit nur zu einem geplanten Bericht gehören. Ein überschneidender Zeitplan liefert 409 conflict.

Ein Bericht mit dem Umfang all überschneidet sich mit jedem anderen Bericht derselben Häufigkeit. Pausierte Berichte zählen mit.

string

erforderlich

Wie oft der Bericht verschickt wird: daily, weekly oder monthly. Legt zugleich den abgedeckten Zeitraum fest. Siehe Zeitraum.

string

erforderlich

all, selected oder single. Siehe Umfang.

string

erforderlich

IANA-Zeitzone, an der Versandzeit und Zeitraum ausgerichtet werden, zum Beispiel America/New_York. Eine unbekannte Zeitzone liefert 422.

string

erforderlich

Sprache der E-Mail und des PDFs, zum Beispiel en oder de. Bei einem nicht unterstützten Wert wird Englisch verwendet. PDFs in zh, ja, ko und ar werden auf Englisch erstellt.

string[]

Einzubeziehende QR-Codes. Erforderlich bei selected (eine oder mehrere IDs) und single (genau eine ID). Jede ID muss ein QR-Code in Ihrem Workspace sein, sonst liefert die Anfrage 404.

string

Bezeichnung, die im Betreff der E-Mail und im Dashboard angezeigt wird, bis zu 40 Zeichen.

boolean

Standard:"false"

Eine PDF-Version des Berichts an die E-Mail anhängen.

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"
}

Geplanten Bericht aktualisieren

PATCH /api/v1/reports/schedules/{id} Ändert einen geplanten Bericht oder pausiert ihn und setzt ihn fort. Senden Sie nur die Felder, die Sie ändern möchten, mindestens eines. Eine Änderung der Häufigkeit oder Zeitzone sowie das Fortsetzen eines pausierten Berichts berechnen nextRunAt neu. Die Regel „ein Bericht pro Häufigkeit“ gilt weiterhin, daher liefert eine überschneidende Änderung 409.

string

erforderlich

ID des geplanten Berichts. Nehmen Sie sie aus der Antwort der Liste oder der Erstellung.

string

paused stoppt die E-Mails, ohne den Zeitplan zu löschen. active setzt sie fort.

string

Bezeichnung, bis zu 40 Zeichen.

string

daily, weekly oder monthly.

string

all, selected oder single.

string[]

Einzubeziehende QR-Codes. Jede ID muss ein QR-Code in Ihrem Workspace sein.

boolean

Ein PDF an die E-Mail anhängen.

string

IANA-Zeitzone.

string

Sprache der E-Mail und des PDFs.

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"
}

Geplanten Bericht löschen

DELETE /api/v1/reports/schedules/{id} Löscht den Zeitplan und stoppt alle weiteren E-Mails.

Das Löschen eines geplanten Berichts lässt sich nicht rückgängig machen.

string

erforderlich

ID des geplanten Berichts.

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

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

Häufige Probleme

404 beim Exportieren eines Berichts

Beim Umfang selected oder single passte keine der qrIds zu einem QR-Code mit Kurzlink in Ihrem Workspace. Prüfen Sie die IDs.

404 "QR not found." beim Planen eines Berichts

Eine der qrIds ist kein QR-Code in Ihrem Workspace oder wurde gelöscht. Prüfen Sie die IDs mit QR-Codes auflisten.

409 beim Planen eines Berichts

Einer der QR-Codes gehört bereits zu einem geplanten Bericht mit derselben Häufigkeit, oder ein Bericht dieser Häufigkeit verwendet den Umfang all. Bearbeiten oder löschen Sie diesen Bericht, oder wählen Sie eine andere Häufigkeit.

404 "Scheduled report not found."

Die id passt zu keinem geplanten Bericht in Ihrem Workspace. Nehmen Sie sie aus Geplante Berichte auflisten.

Im Bericht fehlen die Scans von heute

Berichte decken nur den zuletzt abgeschlossenen Zeitraum ab. Für aktuelle Zahlen verwenden Sie Analytics.

API

Header

Umfang

Zeitraum

Bericht exportieren

JSON-Antwort

CSV- und PDF-Antworten

Das Objekt des geplanten Berichts

Geplante Berichte auflisten

Bericht planen

Geplanten Bericht aktualisieren

Geplanten Bericht löschen

Häufige Probleme

Wie geht es weiter?

Analytics

Geplante Berichte in der App

Berichte lesen

Fehler

​Header

​Umfang

​Zeitraum

​Bericht exportieren

​JSON-Antwort

​CSV- und PDF-Antworten

​Das Objekt des geplanten Berichts

​Geplante Berichte auflisten

​Bericht planen

​Geplanten Bericht aktualisieren

​Geplanten Bericht löschen

​Häufige Probleme

​Wie geht es weiter?

Analytics

Geplante Berichte in der App

Berichte lesen

Fehler

Header

Umfang

Zeitraum

Bericht exportieren

JSON-Antwort

CSV- und PDF-Antworten

Das Objekt des geplanten Berichts

Geplante Berichte auflisten

Bericht planen

Geplanten Bericht aktualisieren

Geplanten Bericht löschen

Häufige Probleme

Wie geht es weiter?