Saltar para o conteúdo principal
A API do GetQR está em versão beta e só está disponível para alguns espaços de trabalho. Os detalhes podem mudar antes do lançamento geral.
Obtenha totais de leituras e discriminações por país, dispositivo, navegador e muito mais, para um único código QR ou para todo o seu espaço de trabalho. Para um resumo já pronto por código QR, consulte Relatórios.

O que significam os números

  • Leituras. Todas as contagens estão no campo clicks. É contada uma leitura sempre que alguém abre a ligação curta do código QR.
  • Leituras únicas. Com unique=true, cada visitante é contado uma única vez no intervalo de datas.
  • Âmbito. Os números vêm da ligação curta do código QR. Um código QR sem ligação curta não tem leituras para contar.
  • Histórico. As estatísticas não podem ser repostas através da API. Eliminar um código QR não apaga os respetivos dados históricos de leituras.

Cabeçalhos

string
obrigatório
Bearer seguido da sua chave de API. Consulte Autenticação.

Parâmetros de consulta

Ambos os endpoints aceitam estes parâmetros. Todos são opcionais.
string
padrão:"count"
Dimensão da discriminação. count devolve o total. Consulte Discriminações para ver todos os valores e a estrutura da respetiva resposta.
string
padrão:"30d"
Intervalo de datas predefinido: 24h, 7d, 30d, 90d, 1y, mtd, qtd, ytd ou all. Consulte Intervalos de datas. É ignorado quando envia start.
string
Início de um intervalo personalizado, ISO 8601, por exemplo 2026-08-01 ou 2026-08-01T00:00:00Z. Tem precedência sobre interval. Tem de ser anterior a end.
string
Fim de um intervalo personalizado, ISO 8601. Por predefinição, o fim do dia de hoje. É usado em conjunto com start ou interval=all, e ignorado com os outros intervalos.
string
padrão:"UTC"
Fuso horário IANA usado para alinhar o agrupamento de timeseries, por exemplo America/New_York. Um fuso horário desconhecido devolve 422.
boolean
padrão:"false"
true conta as leituras únicas em vez das leituras totais.
Também pode enviar filtros de dimensão.

Intervalos de datas

Para um intervalo personalizado, envie start e, opcionalmente, end. Os intervalos até 2 dias são agrupados por hora, os intervalos com mais de 180 dias são agrupados por mês e todos os restantes são agrupados por dia.

Filtros de dimensão

Restrinja os resultados às leituras que correspondem a um filtro. Os filtros diferentes são combinados com AND. Quando um filtro aceita vários valores, separe-os com vírgulas: os valores são combinados com OR. Um código de país ou de continente desconhecido devolve 422. Os nomes de dispositivo, navegador e sistema operativo são comparados com a primeira letra em maiúscula, pelo que mobile funciona como Mobile. Por exemplo, leituras nos EUA ou no Canadá em dispositivos móveis: ?country=US,CA&device=Mobile.

Discriminações

count devolve um objeto. Todos os outros valores devolvem um array, ordenado por clicks do maior para o menor (timeseries é ordenado por tempo). Um groupBy desconhecido devolve 422 com a lista de valores válidos. Resposta quando groupBy=count:
Resposta quando groupBy=countries:

Obter as estatísticas de um código QR

GET /api/v1/qrs/{qrId}/analytics Devolve as estatísticas de leituras de um código QR, limitadas à respetiva ligação curta. Aceita os parâmetros de consulta e os filtros de dimensão acima.
string
obrigatório
ID do código QR. Obtenha-o na resposta da listagem ou da criação de Códigos QR.

Obter as estatísticas do espaço de trabalho

GET /api/v1/analytics Devolve as estatísticas de leituras de todos os códigos QR do seu espaço de trabalho. Aceita os parâmetros de consulta e os filtros de dimensão acima, mais estes parâmetros de âmbito.
string
Com key, limita os resultados à ligação curta com este domínio, por exemplo getqr.sh. O domínio tem de pertencer ao seu espaço de trabalho.
string
Slug da ligação curta, por exemplo x7Kd2p1. Use-o em conjunto com domain. Ambos estão no objeto de código QR.
string
Tipos de código QR a incluir, separados por vírgulas: website, pdf, image, video, whatsapp, social, wifi, app, feedback, vcard, sms, payment, location, multilink, email ou event. Consulte Tipos de QR.

Problemas comuns

Não existe no seu espaço de trabalho nenhuma ligação curta com esse domínio e esse slug. Copie domain e key do objeto de código QR.
O valor não é suportado. A mensagem de erro indica o parâmetro e lista os valores válidos.
Verifique se usa o mesmo intervalo de datas e o mesmo fuso horário, e se conta leituras únicas (unique=true) ou leituras totais.

Próximos passos

Relatórios

Códigos QR

Estatísticas na aplicação

Limites de pedidos