Documentação da API

Análise

API de Análise

Rastreie e analise o desempenho de códigos QR com dados de digitalização detalhados, informações geográficas, desagregações de dispositivos e análise de tendências.

Tendências de Digitalização

Rastreie digitalizações ao longo do tempo com desagregações diárias, semanais ou mensais

Dados Geográficos

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

Informações do Dispositivo

Entenda os tipos de dispositivos, sistemas operacionais e navegadores

Dados de Referência

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

Endpoints

Método	Endpoint	Descrição
GET	/organizations/:orgId/qr-codes/analytics	Análise em toda a organização
GET	/organizations/:orgId/qr-codes/:id/analytics	Análise de código QR único
GET	/organizations/:orgId/qr-codes/:id/analytics/export	Exportar análises como CSV
GET	/organizations/:orgId/qr-codes/:id/scans	Obter registros de digitalização individuais

Obter Análise de Código QR

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

GET

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

Parâmetros de Consulta

Parâmetro	Tipo	Descrição
startDate	string	Data de início (formato ISO 8601)
endDate	string	Data de término (formato ISO 8601)
interval	string	Intervalo 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 desagregação geográfica detalhada das digitalizações por país e cidade. Esses dados são derivados da geolocalização IP das solicitações de digitalização.

Dados Geográficos Disponíveis

• País: código do país ISO e contagem de digitalizações
• Cidade: nome da cidade com contexto do país
• Porcentagem: Distribuição relativa de scans
• Coordenadas: Latitude/longitude aproximada (quando disponível)

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 dados analíticos 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

Coluna	Descrição
timestamp	Timestamp do scan (ISO 8601)
country	Código do país
city	Nome da cidade
device_type	móvel, desktop, tablet
os	Sistema operacional
browser	Nome do navegador
is_unique	Scan de primeira vez (verdadeiro/falso)

Análises em toda a organização

Obtenha análises agregadas de todos os QR codes 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: