Documentação da API
Análise

API de Análise

Rastreie e analise o desempenho do código QR com dados de escaneamento detalhados, informações geográficas, divisões por dispositivo e análise de tendências.

Tendências de Escaneamento

Acompanhe as digitalizações ao longo do tempo com divisões diárias, semanais ou mensais.

Dados Geográficos

Veja onde seus códigos QR estão sendo escaneados por país e cidade

Informações do Dispositivo

Entenda os tipos de dispositivos, sistemas operacionais e navegadores

Dados do Referenciador

Rastreie de onde as digitalizações se originam para atribuição de campanha

Pontos finais

MétodoPonto finalDescrição
GET
/organizations/:orgId/qr-codes/analyticsAnálise em toda a organização
GET
/organizations/:orgId/qr-codes/:id/analyticsAnálise de QR code único
GET
/organizations/:orgId/qr-codes/:id/analytics/exportExportar análises como CSV
GET
/organizations/:orgId/qr-codes/:id/scansObter registros de escaneamento individuais

Obter Análises de QR Code

Recupere análises abrangentes para um código QR específico.

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

Parâmetros de Consulta

ParâmetroTipoDescrição
startDatestringData de início (formato ISO 8601)
endDatestringData de término (formato ISO 8601)
intervalstringIntervalo de agrupamento: dia, semana, mês
Exemplo de Solicitação
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"

Resposta

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

Análise Geográfica

A resposta de análise inclui uma divisão geográfica detalhada de scans por país e cidade. Esses dados são derivados da geolocalização de IP das solicitações de scan.

Dados Geográficos Disponíveis

  • País: código de país ISO e contagem de scans
  • Cidade: Nome da cidade com contexto do país
  • Porcentagem: Distribuição relativa de scans
  • Coordenadas: Latitude/longitude aproximadas (quando disponíveis)

Nota de Privacidade: Não armazenamos localizações exatas dos usuários. Os dados geográficos são derivados de endereços IP e fornecem precisão aproximada ao nível da cidade.

Exportar Análises

Exporte os dados de análise como CSV para análise adicional em planilhas ou ferramentas de BI.

GET
/organizations/:orgId/qr-codes/:id/analytics/export
Exportar para 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

Colunas CSV

ColunaDescrição
timestampCarimbo de data/hora (ISO 8601)
countryCódigo do país
cityNome da cidade
device_typemóvel, desktop, tablet
osSistema operacional
browserNome do navegador
is_uniquePrimeira digitalização (verdadeiro/falso)

Análise em toda a organização

Obtenha análises agregadas de todos os códigos QR em sua organização.

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"

Próximos Passos

Saiba mais sobre recursos relacionados: