API 文件

分析

分析 API

追蹤和分析 QR 碼性能，提供詳細的掃描數據、地理信息、設備分類和趨勢分析。

掃描趨勢

隨著時間的推移追蹤掃描，提供每日、每週或每月的分類

地理數據

查看您的 QR 碼在哪些國家和城市被掃描

設備信息

了解設備類型、操作系統和瀏覽器

引薦數據

追蹤掃描來源以進行活動歸因

端點

方法	端點	描述
GET	/organizations/:orgId/qr-codes/analytics	組織範圍的分析
GET	/organizations/:orgId/qr-codes/:id/analytics	單一 QR 碼分析
GET	/organizations/:orgId/qr-codes/:id/analytics/export	將分析導出為 CSV
GET	/organizations/:orgId/qr-codes/:id/scans	獲取個別掃描記錄

獲取 QR 碼分析

檢索特定 QR 碼的綜合分析。

GET

/organizations/:orgId/qr-codes/:id/analytics

查詢參數

參數	類型	描述
startDate	string	開始日期（ISO 8601 格式）
endDate	string	結束日期（ISO 8601 格式）
interval	string	分組間隔：天、週、月

範例請求

curl -X GET \
  "https://api.iloveqr.com/api/v1/organizations/org_abc123/qr-codes/qr_xyz789/analytics?startDate=2024-01-01&endDate=2024-01-31&interval=day" \
  -H "X-API-Key: YOUR_API_KEY"

回應

{
  "qrCodeId": "qr_xyz789",
  "period": {
    "start": "2024-01-01T00:00:00Z",
    "end": "2024-01-31T23:59:59Z"
  },
  "summary": {
    "totalScans": 1542,
    "uniqueScans": 1203,
    "avgDailyScans": 49.7
  },
  "timeline": [
    { "date": "2024-01-01", "scans": 45, "uniqueScans": 38 },
    { "date": "2024-01-02", "scans": 52, "uniqueScans": 41 },
    ...
  ],
  "geography": {
    "countries": [
      { "country": "US", "scans": 823, "percentage": 53.4 },
      { "country": "GB", "scans": 234, "percentage": 15.2 },
      { "country": "DE", "scans": 156, "percentage": 10.1 }
    ],
    "cities": [
      { "city": "New York", "country": "US", "scans": 234 },
      { "city": "London", "country": "GB", "scans": 189 },
      { "city": "Los Angeles", "country": "US", "scans": 145 }
    ]
  },
  "devices": {
    "types": [
      { "type": "mobile", "scans": 1234, "percentage": 80.0 },
      { "type": "desktop", "scans": 231, "percentage": 15.0 },
      { "type": "tablet", "scans": 77, "percentage": 5.0 }
    ],
    "os": [
      { "os": "iOS", "scans": 687, "percentage": 44.6 },
      { "os": "Android", "scans": 547, "percentage": 35.5 },
      { "os": "Windows", "scans": 189, "percentage": 12.3 }
    ],
    "browsers": [
      { "browser": "Safari", "scans": 654, "percentage": 42.4 },
      { "browser": "Chrome", "scans": 521, "percentage": 33.8 },
      { "browser": "Firefox", "scans": 156, "percentage": 10.1 }
    ]
  }
}

地理分析

分析回應包括按國家和城市的掃描詳細地理細分。這些數據源自掃描請求的 IP 地理位置。

可用的地理數據

• 國家： ISO 國家代碼和掃描次數
• 城市： 帶有國家上下文的城市名稱
• 百分比： 掃描的相對分佈
• 坐標： 大約的緯度/經度（如可用）

隱私注意： 我們不存儲精確的用戶位置。地理數據源自 IP 地址，提供大約的城市級準確性。

導出分析

將分析數據導出為 CSV，以便在電子表格或 BI 工具中進行進一步分析。

GET

/organizations/:orgId/qr-codes/:id/analytics/export

導出為 CSV

curl -X GET \
  "https://api.iloveqr.com/api/v1/organizations/org_abc123/qr-codes/qr_xyz789/analytics/export?startDate=2024-01-01&endDate=2024-01-31" \
  -H "X-API-Key: YOUR_API_KEY" \
  -o analytics.csv

CSV 列

列	描述
timestamp	掃描時間戳（ISO 8601）
country	國家代碼
city	城市名稱
device_type	移動、桌面、平板
os	操作系統
browser	瀏覽器名稱
is_unique	首次掃描（真/假）

組織範圍的分析

獲取您組織中所有 QR 碼的聚合分析。

GET

/organizations/:orgId/qr-codes/analytics

curl -X GET \
  "https://api.iloveqr.com/api/v1/organizations/org_abc123/qr-codes/analytics?startDate=2024-01-01&endDate=2024-01-31" \
  -H "X-API-Key: YOUR_API_KEY"

後續步驟

了解相關功能：

分析