Ana içeriğe atla
GetQR API’si beta aşamasındadır ve seçili çalışma alanlarında kullanılabilir. Ayrıntılar genel sürümden önce değişebilir.
Raporlar, tamamlanmış bir gün, hafta veya ay için QR kodu başına taramaları özetler. Hemen bir rapor dışa aktarın veya düzenli olarak e-postayla gönderilen bir rapor zamanlayın.

Başlıklar

string
gerekli
Bearer ve ardından API anahtarınız. Bkz. Kimlik doğrulama.
string
application/json. POST ve PATCH isteklerinde zorunludur.

Kapsam

Tek seferlik ve zamanlanmış raporların ikisi de bir scope alır: Bir rapor en fazla 50 QR kodunu listeler. all ile bunlar en son oluşturulan aktif QR kodlarıdır; duraklatılmış kodlar dahil edilmez. selected ve single ile duraklatılmış kodlar dahil edilir. Kısa bağlantısı olmayan QR kodlarının taraması yoktur ve atlanır.

Dönem

Dönem her zaman son tamamlanmış dönemdir; bu nedenle bir rapor hiçbir zaman bugünün kısmi verilerini içermez. Dönemin sınırları, raporun saat dilimindeki gece yarısıdır.

Rapor dışa aktarma

POST /api/v1/reports Son tamamlanmış dönem için bir rapor oluşturur ve yanıtta döndürür.
string
gerekli
all, selected veya single. Bkz. Kapsam.
string
gerekli
daily, weekly veya monthly. Bkz. Dönem.
string
gerekli
json, raporu yanıt gövdesinde döndürür. csv ve pdf bir dosya indirmesi döndürür.
string[]
Kapsanacak QR kodları. selected (bir veya daha fazla kimlik) ve single (tam olarak bir kimlik) için zorunludur. all için göndermeyin.
string
varsayılan:"UTC"
Dönem sınırlarının hizalandığı IANA saat dilimi; örneğin America/New_York. Bilinmeyen bir saat dilimi 422 döndürür.
string
varsayılan:"en"
PDF’in dili; örneğin en veya de. Desteklenmeyen bir değer İngilizceye döner. csv ve json tarafından yok sayılır.
string
PDF’te gösterilen başlık; en fazla 40 karakter. csv ve json tarafından yok sayılır.

JSON yanıtı

string
Dönemin ilk günü, YYYY-MM-DD.
string
Dönemden sonraki ilk gün, YYYY-MM-DD. Dönem bu günün başındaki gece yarısında sona erer.
object[]
QR kodu başına bir kayıt.

CSV ve PDF yanıtları

Gövde dosyanın kendisidir. Content-Disposition, dosyayı döneme göre adlandırır; örneğin report-2026-08-10_2026-08-17.csv. CSV’de QR kodu başına bir satır ve QR ID, QR name, QR type, Total scans, Unique scans, Top geography, Top device, Top OS ve Top browser sütunları bulunur.

Zamanlanmış rapor nesnesi

Zamanlanmış bir rapor, kendi saat dilimindeki gece yarısında, onu oluşturan hesaba e-postayla gönderilir.
string
Zamanlanmış raporun kimliği.
string | null
E-posta konusunda ve panelde gösterilen etiket.
string
daily, weekly veya monthly.
string
all, selected veya single.
string[] | null
selected ve single kapsamlarında raporun kapsadığı QR kodları. Hiç kimlik gönderilmediyse null.
null
Her zaman null. Ayrılmıştır.
boolean
E-postaya PDF eklenip eklenmediği.
string
active veya paused.
string
Gönderim zamanının ve dönemin hizalandığı IANA saat dilimi.
string
E-postanın ve PDF’in dili.
string
Bir sonraki e-postanın zamanı, ISO 8601: raporun saat diliminde bir sonraki gece yarısı (daily), bir sonraki pazartesi (weekly) veya bir sonraki ayın 1’i (monthly).
string | null
Son e-postanın gönderildiği zaman, ISO 8601.
string
Oluşturulma tarihi, ISO 8601.
string
Son güncelleme tarihi, ISO 8601.

Zamanlanmış raporları listeleme

GET /api/v1/reports/schedules Diğer üyelerin oluşturdukları dahil, çalışma alanınızın zamanlanmış raporlarını en yeniden başlayarak döndürür. Liste sayfalıdır: bkz. Sayfalama.
integer
varsayılan:"1"
Döndürülecek sayfa; 1 veya daha büyük.
integer
varsayılan:"100"
Sayfa başına sonuç; 1 ile 100 arası.

Rapor zamanlama

POST /api/v1/reports/schedules Düzenli olarak e-postayla gönderilen bir rapor oluşturur. nextRunAt, sıklığa ve saat dilimine göre hesaplanır.
Bir QR kodu, her sıklık için yalnızca bir zamanlanmış rapora ait olabilir. Çakışan bir zamanlama 409 conflict döndürür.
all kapsamlı bir rapor, aynı sıklıktaki diğer tüm raporlarla çakışır. Duraklatılmış raporlar da sayılır.
string
gerekli
Raporun ne sıklıkla gönderileceği: daily, weekly veya monthly. Kapsadığı dönemi de belirler. Bkz. Dönem.
string
gerekli
all, selected veya single. Bkz. Kapsam.
string
gerekli
Gönderim zamanının ve dönemin hizalandığı IANA saat dilimi; örneğin America/New_York. Bilinmeyen bir saat dilimi 422 döndürür.
string
gerekli
E-postanın ve PDF’in dili; örneğin en veya de. Desteklenmeyen bir değer İngilizceye döner. zh, ja, ko ve ar dillerindeki PDF’ler İngilizce oluşturulur.
string[]
Kapsanacak QR kodları. selected (bir veya daha fazla kimlik) ve single (tam olarak bir kimlik) için zorunludur. Her kimlik çalışma alanınızdaki bir QR koduna ait olmalıdır; aksi hâlde istek 404 döndürür.
string
E-posta konusunda ve panelde gösterilen etiket; en fazla 40 karakter.
boolean
varsayılan:"false"
Raporun PDF sürümünü e-postaya ekler.

Zamanlanmış raporu güncelleme

PATCH /api/v1/reports/schedules/{id} Zamanlanmış bir raporu değiştirir ya da duraklatır ve sürdürür. Yalnızca değiştirmek istediğiniz alanları, en az bir tane olmak üzere gönderin. Sıklığı veya saat dilimini değiştirmek ya da duraklatılmış bir raporu sürdürmek nextRunAt değerini yeniden hesaplar. Sıklık başına tek rapor kuralı yine geçerlidir; bu nedenle çakışan bir değişiklik 409 döndürür.
string
gerekli
Zamanlanmış raporun kimliği. Liste veya oluşturma yanıtından alın.
string
paused, zamanlamayı silmeden e-postaları durdurur. active e-postaları sürdürür.
string
Etiket; en fazla 40 karakter.
string
daily, weekly veya monthly.
string
all, selected veya single.
string[]
Kapsanacak QR kodları. Her kimlik çalışma alanınızdaki bir QR koduna ait olmalıdır.
boolean
E-postaya bir PDF ekler.
string
IANA saat dilimi.
string
E-postanın ve PDF’in dili.

Zamanlanmış raporu silme

DELETE /api/v1/reports/schedules/{id} Zamanlamayı siler ve sonraki tüm e-postaları durdurur.
Zamanlanmış bir raporu silme işlemi geri alınamaz.
string
gerekli
Zamanlanmış raporun kimliği.

Sık karşılaşılan sorunlar

selected veya single kapsamında, qrIds değerlerinden hiçbiri çalışma alanınızda kısa bağlantısı olan bir QR koduyla eşleşmedi. Kimlikleri kontrol edin.
qrIds değerlerinden biri çalışma alanınızdaki bir QR kodu değil veya silinmiş. Kimlikleri QR kodlarını listeleme ile kontrol edin.
QR kodlarından biri zaten aynı sıklıktaki bir zamanlanmış rapora ait veya bu sıklıktaki bir rapor all kapsamını kullanıyor. O raporu düzenleyin veya silin ya da farklı bir sıklık seçin.
id, çalışma alanınızdaki hiçbir zamanlanmış raporla eşleşmiyor. Değeri Zamanlanmış raporları listeleme yanıtından alın.
Raporlar yalnızca son tamamlanmış dönemi kapsar. Anlık sayılar için Analizler uç noktasını kullanın.

Sırada ne var

Analizler

Uygulamada zamanlanmış raporlar

Raporları okuma

Hatalar