Glossário

Os termos que aparecem na AI Web Push API, definidos em poucas linhas. Os nomes de campo estão como a API os usa.

Campanha: Uma notificação de web push (título, texto, link e, opcionalmente, ícone, imagem e botão) enviada para um conjunto de tópicos e/ou países de um site. É a unidade que a API cria, lista, consulta e exclui. Cada campanha tem um id devolvido na criação.
Web push: Notificação enviada pelo navegador a quem aceitou recebê-la num site, mesmo com o site fechado. Na AI Web Push, os visitantes entram na base pelo plugin WordPress instalado no site.
Tópico (topics): Interesse de um grupo de inscritos, como tecnologia ou esportes. A IA da AI Web Push classifica o conteúdo que cada inscrito lê, e o dono do site também pode cadastrar tópicos no painel. GET /topics lista os tópicos do site que têm inscritos, em minúsculas — use os nomes exatamente como vieram.
País (countries): Agrupamento de inscritos por país, em minúsculas e com o prefixo country__ (por exemplo country__brazil; quem não teve o país identificado cai em country__desconhecido). GET /countries lista os países com inscritos; na criação da campanha, tópicos e países são juntados numa lista só de destinos.
Inscrito: Visitante que aceitou receber notificações do site. O campo users de tópicos e países e o totalUsers da campanha contam inscritos.
status (da campanha): Situação definida na criação: published (entra na fila de envio), draft (só guarda, não envia) ou failed (envio falhou). Uma campanha já enviada continua aparecendo como published.
status (filtro da listagem): No filtro de POST /campaigns, o campo aceita outros valores: draft, scheduled (publicada, envio ainda por acontecer), sent (publicada, envio já realizado) e failed.
scheduleMode: Como o envio acontece: now envia na hora; scheduled envia na data de scheduleDate.
scheduleDate: Data e hora do envio, em UTC, formato ISO 8601: 2025-05-02T18:30:00Z. Obrigatória quando scheduleMode é scheduled.
TTL (ttl): Time to live: por quanto tempo, em segundos, a notificação continua valendo se o dispositivo estiver offline. Vai até 2419200 segundos (28 dias), que também é o padrão — enviar 0 resulta no padrão. Nas respostas, o ttl também vem em segundos e o ttlUnit é sempre seconds.
callToAction: Texto do botão da notificação, com até 20 caracteres.
UTM (utmSource, utmMedium, utmCampaign): Parâmetros de rastreamento anexados ao link da campanha, para o clique aparecer identificado no seu analytics.
Cursor (cursor / nextCursor): Marcador de paginação da listagem. A resposta traz nextCursor quando há mais páginas (hasMore: true); envie esse valor, sem alterar, no campo cursor da chamada seguinte, com os mesmos filtros e o mesmo limit.
Impressões (impressions): Quantas vezes a notificação da campanha foi exibida nos dispositivos.
Cliques (clicks): Quantas vezes a notificação foi clicada, abrindo o link da campanha.
CTR (ctr): Click-through rate: percentual de cliques sobre as impressões, com duas casas decimais. Vem 0 quando não houve exibições.
ITS (its): Percentual de impressões sobre a base de usuários alcançada (totalUsers), com duas casas decimais — quanto da base efetivamente viu a notificação. Vem 0 quando a base é zero.
totalUsers: Audiência estimada quando a campanha foi agendada; é a base usada no cálculo do ITS.

Termo que não está aqui? Procure na Referência — cada campo tem descrição própria — ou pergunte em contato@aiwebpush.com.